Class IgbRating

Rating provides insight regarding others' opinions and experiences, and can allow the user to submit a rating of their own @cssproperty --symbol-size - The size of the symbols. @cssproperty --symbol-full-color - The color of the filled symbol. @cssproperty --symbol-empty-color - The color of the empty symbol. @cssproperty --symbol-full-filter - The filter(s) used for the filled symbol. @cssproperty --symbol-empty-filter - The filter(s) used for the empty symbol.

Inheritance
System.Object
BaseRendererControl
IgbRating
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbRating : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbRating()

Declaration
public IgbRating()

Properties

AllowReset

Whether to reset the rating when the user selects the same value.

Declaration
public bool AllowReset { get; set; }
Property Value
Type Description
System.Boolean

Change

Declaration
public EventCallback<IgbNumberEventArgs> Change { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbNumberEventArgs>

ChangeScript

Declaration
public string ChangeScript { get; set; }
Property Value
Type Description
System.String

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

DirectRenderElementName

Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type Description
System.String
Overrides

Disabled

The disabled state of the component

Declaration
public bool Disabled { get; set; }
Property Value
Type Description
System.Boolean

Hover

Declaration
public EventCallback<IgbNumberEventArgs> Hover { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbNumberEventArgs>

HoverPreview

Sets hover preview behavior for the component

Declaration
public bool HoverPreview { get; set; }
Property Value
Type Description
System.Boolean

HoverScript

Declaration
public string HoverScript { get; set; }
Property Value
Type Description
System.String

Invalid

Control the validity of the control.

Declaration
public bool Invalid { get; set; }
Property Value
Type Description
System.Boolean

Label

The label of the control.

Declaration
public string Label { get; set; }
Property Value
Type Description
System.String

Max

The maximum value for the rating. If there are projected symbols, the maximum value will be resolved based on the number of symbols. @default 5

Declaration
public double Max { get; set; }
Property Value
Type Description
System.Double

ReadOnly

Makes the control a readonly field.

Declaration
[WCAttributeName("readonly")]
public bool ReadOnly { get; set; }
Property Value
Type Description
System.Boolean

Single

Toggles single selection visual mode. @default false

Declaration
public bool Single { get; set; }
Property Value
Type Description
System.Boolean

Step

The minimum value change allowed. Valid values are in the interval between 0 and 1 inclusive. @default 1

Declaration
public double Step { get; set; }
Property Value
Type Description
System.Double

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseDirectRender

Declaration
protected override bool UseDirectRender { get; }
Property Value
Type Description
System.Boolean
Overrides

Value

The current value of the component @default 0

Declaration
public double Value { get; set; }
Property Value
Type Description
System.Double

ValueChanged

Declaration
public EventCallback<double> ValueChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.Double>

ValueFormat

A format string which sets aria-valuetext. Instances of '{0}' will be replaced with the current value of the control and instances of '{1}' with the maximum value for the control. Important for screen-readers and useful for localization.

Declaration
public string ValueFormat { get; set; }
Property Value
Type Description
System.String

Methods

CheckValidity()

Declaration
public void CheckValidity()

CheckValidityAsync()

Checks for validity of the control and emits the invalid event if it invalid.

Declaration
public Task CheckValidityAsync()
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

GetCurrentValue()

Declaration
public double GetCurrentValue()
Returns
Type Description
System.Double

GetCurrentValueAsync()

Declaration
public Task<double> GetCurrentValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

ReportValidity()

Declaration
public void ReportValidity()

ReportValidityAsync()

Checks for validity of the control and shows the browser message if it invalid.

Declaration
public Task ReportValidityAsync()
Returns
Type Description
System.Threading.Tasks.Task

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

SetCustomValidity(String)

Declaration
public void SetCustomValidity(string message)
Parameters
Type Name Description
System.String message

SetCustomValidityAsync(String)

Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.

Declaration
public Task SetCustomValidityAsync(string message)
Parameters
Type Name Description
System.String message
Returns
Type Description
System.Threading.Tasks.Task

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

SetParametersAsync(ParameterView)

Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.ParameterView parameters
Returns
Type Description
System.Threading.Tasks.Task

StepDown(Double)

Declaration
public void StepDown(double n = 1)
Parameters
Type Name Description
System.Double n

StepDownAsync(Double)

Decrements the value of the control by n steps multiplied by the step factor.

Declaration
public Task StepDownAsync(double n = 1)
Parameters
Type Name Description
System.Double n
Returns
Type Description
System.Threading.Tasks.Task

StepUp(Double)

Declaration
public void StepUp(double n = 1)
Parameters
Type Name Description
System.Double n

StepUpAsync(Double)

Increments the value of the control by n steps multiplied by the step factor.

Declaration
public Task StepUpAsync(double n = 1)
Parameters
Type Name Description
System.Double n
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable