Class RatingPropertiesBuilder

Inheritance

System.Object

RatingPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class RatingPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

RatingPropertiesBuilder()

Initializes a new instance of the RatingPropertiesBuilder class.

Declaration

public RatingPropertiesBuilder()

RatingPropertiesBuilder(Rating)

Initializes a new instance of the RatingPropertiesBuilder class.

Declaration

public RatingPropertiesBuilder(Rating rating)

Parameters

Type	Name	Description
Rating	rating	Accepts the Rating properties

Fields

rating

Represents the Rating field.

Declaration

public Rating rating

Field Value

Type	Description
Rating

Methods

AllowReset()

Enables the rating control with reset button.It can be used to reset the rating control value.

Declaration

public RatingPropertiesBuilder AllowReset()

Returns

Type	Description
RatingPropertiesBuilder	This method returns boolean value

AllowReset(Boolean)

Enables the rating control with reset button.It can be used to reset the rating control value.with boolean argument.

Declaration

public RatingPropertiesBuilder AllowReset(bool allowReset)

Parameters

Type	Name	Description
System.Boolean	allowReset	allowReset

Returns

Type	Description
RatingPropertiesBuilder	This method returns boolean value

ClientSideEvents(Action<RatingClientSideEventsBuilder>)

RatingPropertiesBuilder ClientSide Events

Declaration

public RatingPropertiesBuilder ClientSideEvents(Action<RatingClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<RatingClientSideEventsBuilder>	clientSideEvents	clientSideEvents

Returns

Type	Description
RatingPropertiesBuilder	This method returns rating properties builder value

CssClass(String)

Specify the CSS class to achieve custom theme.

Declaration

public RatingPropertiesBuilder CssClass(string customCssClass)

Parameters

Type	Name	Description
System.String	customCssClass	customCssClass

Returns

Type	Description
RatingPropertiesBuilder	This method returns string value

Enabled()

When this property is set to false, it disables the rating control.

Declaration

public RatingPropertiesBuilder Enabled()

Returns

Type	Description
RatingPropertiesBuilder	This method returns boolean value

Enabled(Boolean)

When this property is set to false, it disables the rating control.with boolean argument.

Declaration

public RatingPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled	enabled

Returns

Type	Description
RatingPropertiesBuilder	This method returns boolean value

EnablePersistence()

Save current model value to browser cookies for state maintanence. While refresh the page Rating control values are retained.

Declaration

public RatingPropertiesBuilder EnablePersistence()

Returns

Type	Description
RatingPropertiesBuilder	This method returns boolean value

EnablePersistence(Boolean)

Save current model value to browser cookies for state maintanence. While refresh the page Rating control values are retained.with boolean argument.

Declaration

public RatingPropertiesBuilder EnablePersistence(bool enablePersistence)

Parameters

Type	Name	Description
System.Boolean	enablePersistence	enablePersistence

Returns

Type	Description
RatingPropertiesBuilder	This method returns boolean value

Height(String)

Specifies the height of the Rating control wrapper.

Declaration

public RatingPropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height	height

Returns

Type	Description
RatingPropertiesBuilder	This method returns string value

HtmlAttributes(IDictionary<String, Object>)

Specifies the HTML Attributes of the Rating control.

Declaration

public RatingPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	itemHtmlAttributes	itemHtmlAttributes

Returns

Type	Description
RatingPropertiesBuilder	This method returns object value

IncrementStep(Int32)

Specifies the value to be increased while navigating between shapes(stars) in Rating control.

Declaration

public RatingPropertiesBuilder IncrementStep(int incrementStep)

Parameters

Type	Name	Description
System.Int32	incrementStep	incrementStep

Returns

Type	Description
RatingPropertiesBuilder	This method returns number value

MaxValue(Int32)

Allow to render the maximum number of Rating shape(star).

Declaration

public RatingPropertiesBuilder MaxValue(int maxValue)

Parameters

Type	Name	Description
System.Int32	maxValue	maxValue

Returns

Type	Description
RatingPropertiesBuilder	This method returns number value

MinValue(Int32)

Allow to render the minimum number of Rating shape(star).

Declaration

public RatingPropertiesBuilder MinValue(int minValue)

Parameters

Type	Name	Description
System.Int32	minValue	minValue

Returns

Type	Description
RatingPropertiesBuilder	This method returns number value

Orientation(Orientation)

Specifies the orientation of Rating control.

Declaration

public RatingPropertiesBuilder Orientation(Orientation orientation)

Parameters

Type	Name	Description
Orientation	orientation	orientation

Returns

Type	Description
RatingPropertiesBuilder	This method returns enum value

Precision(Precision)

Helps to provide more precise ratings.Rating control supports three precision modes - full, half, and exact.

Declaration

public RatingPropertiesBuilder Precision(Precision precision)

Parameters

Type	Name	Description
Precision	precision	precision

Returns

Type	Description
RatingPropertiesBuilder	This method returns enum value

ReadOnly()

Interaction with Rating control can be prevented by enabling this API.

Declaration

public RatingPropertiesBuilder ReadOnly()

Returns

Type	Description
RatingPropertiesBuilder	This method returns boolean value

ReadOnly(Boolean)

Interaction with Rating control can be prevented by enabling this API.with boolean argument.

Declaration

public RatingPropertiesBuilder ReadOnly(bool readOnly)

Parameters

Type	Name	Description
System.Boolean	readOnly	readOnly

Returns

Type	Description
RatingPropertiesBuilder	This method returns boolean value

Render()

Renders this instance.

Declaration

public void Render()

ShapeHeight(Int32)

To specify the height of each shape in Rating control.

Declaration

public RatingPropertiesBuilder ShapeHeight(int shapeHeight)

Parameters

Type	Name	Description
System.Int32	shapeHeight	shapeHeight

Returns

Type	Description
RatingPropertiesBuilder	This method returns number value

ShapeWidth(Int32)

To specify the width of each shape in Rating control.

Declaration

public RatingPropertiesBuilder ShapeWidth(int shapeWidth)

Parameters

Type	Name	Description
System.Int32	shapeWidth	shapeWidth

Returns

Type	Description
RatingPropertiesBuilder	This method returns number value

ShowTooltip()

Enables the tooltip option.Currently selected value will be displayed in tooltip.

Declaration

public RatingPropertiesBuilder ShowTooltip()

Returns

Type	Description
RatingPropertiesBuilder	This method returns boolean value

ShowTooltip(Boolean)

Enables the tooltip option.Currently selected value will be displayed in tooltip.with boolean argument.

Declaration

public RatingPropertiesBuilder ShowTooltip(bool showTooltip)

Parameters

Type	Name	Description
System.Boolean	showTooltip	showTooltip

Returns

Type	Description
RatingPropertiesBuilder	This method returns boolean value

ToHtmlString()

Returns an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

Value(Double)

To specify the number of stars to be selected while rendering.

Declaration

public RatingPropertiesBuilder Value(double value)

Parameters

Type	Name	Description
System.Double	value	value

Returns

Type	Description
RatingPropertiesBuilder	This method returns number value

Width(String)

Specifies the width of the Rating control wrapper.

Declaration

public RatingPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width	width

Returns

Type	Description
RatingPropertiesBuilder	This method returns string value

Implements

IPropertiesBuilder

System.Web.IHtmlString