New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RadRating

Class

RadRating class

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

[EmbeddedSkin("Rating")]
[EmbeddedSkin("Rating", "Default")]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadRating))]
[ValidationProperty("Value")]
[ClientScriptResource("Telerik.Web.UI.RadRating", "Telerik.Web.UI.Rating.RadRating.js")]
[TelerikToolboxCategory("Miscellaneous")]
[ToolboxBitmap(typeof(RadRating), "Toolbox.Icons.Rating.png")]
[RequiredScript(typeof(jQueryPlugins))]
public class RadRating : RadDataBoundControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, IPostBackEventHandler

Inheritance: objectControlWebControlBaseDataBoundControlDataBoundControlRadDataBoundControlRadRating...

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIFeatureGroupIParserAccessorIPostBackDataHandlerIPostBackEventHandlerIScriptControlISkinnableControlIUrlResolutionService...

Constructors

RadRating()

public RadRating()

Properties

AppendDataBoundItems

bool

Gets/Sets a value indicating whether the DataBound items should be appended to the Rating Items collection, or the collection should be cleared before creating the DataBound items.

public bool AppendDataBoundItems { get; set; }

AutoPostBack

bool

Get/Set a value indicating whether the RadRating control will initiate a postback after its value changes.

[ClientControlProperty]
[ClientPropertyName("_autoPostBack")]
public bool AutoPostBack { get; set; }

CssClassFormatString

string

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

protected override string CssClassFormatString { get; }

Overrides: RadDataBoundControl.CssClassFormatString

Example:

protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

DbValue

object

Gets or sets the value of RadRating in a database-friendly way.

[Browsable(false)]
[TypeConverter(typeof(DecimalConverter))]
[Bindable(true, BindingDirection.TwoWay)]
public object DbValue { get; set; }

Property Value:

A decimal object that represents the value. The default value is 0m.

This property behaves exactly as the Value property. The only difference is that it will not throw an exception if the new value is null or DBNull. Setting a null value will revert the selected value to 0m.

Example:

cs-api-definition
private void Page_Load(object sender, System.EventArgs e)
{
RadRating1.DbValue = tableRow["Rating"];
}
cs-api-definition.skip-repl
Private Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
RadRating1.DbValue = tableRow("Rating")
End Sub

EnableToolTips

bool

Get/Set a value indicating whether the RadRating control will display a browser toolip for its values.

[ClientControlProperty]
public bool EnableToolTips { get; set; }

IsDirectionReversed

bool

Get/Set the direction of the RadRating control, that is, the position of the item (star) with value 1.

[ClientControlProperty]
public bool IsDirectionReversed { get; set; }

ItemBinding

RatingItemBinding

Gets the object through which the user should provide the binding information about the rating items.

[PersistenceMode(PersistenceMode.InnerProperty)]
public RatingItemBinding ItemBinding { get; }

ItemCount

int

Get/Set the number of items in the RadRating control - e.g. the number of stars that the control will have.

[ClientControlProperty]
[ClientPropertyName("_itemCount")]
public int ItemCount { get; set; }

ItemHeight

Unit

Get/Set the height of each item in the RadRating control.

[ClientControlProperty]
[ClientPropertyName("_itemHeight")]
public Unit ItemHeight { get; set; }

Property Value:

Default: Unit.Empty

Items

RadRatingItemCollection

Gets a RadRatingItemCollection object that contains the items of the current RadRating control.

[PersistenceMode(PersistenceMode.InnerProperty)]
public RadRatingItemCollection Items { get; }

Property Value:

A RadRatingItemCollection that contains the items of the current RadRating control. By default the collection is empty (RadRating creates its items, based on the value of its ItemCount property).

Use the Items property to access the child items of RadRating. You can add, remove or modify items from the Items collection.

ItemWidth

Unit

Get/Set the width of each item in the RadRating control.

[ClientControlProperty]
[ClientPropertyName("_itemWidth")]
public Unit ItemWidth { get; set; }

Property Value:

Default: Unit.Empty

OnClientLoad

string

Gets or sets a value indicating the client-side event handler that is called when the RadRating control is initialized.

[ClientControlEvent]
[ClientPropertyName("load")]
public string OnClientLoad { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is an empty string.

Two parameters are passed to the handler:

sender, the RadRating object that raised the event.
args.

This event cannot be cancelled.

Example:

The following example demonstrates how to use the <strong>OnClientLoad</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientLoad(sender, args)<br />
         {<br />
             var ratingControl = sender;<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;telerik:RadRating ID="RadRating1" runat="server"<br />
        <strong>OnClientLoad="OnClientLoad"</strong>&gt;<br />
        ....<br />
        &lt;/telerik:RadRating&gt;
    </div>
</p>

OnClientRated

string

Gets or sets a value indicating the client-side event handler that is called when the user clicks an item (star) of the RadRating control.

[ClientControlEvent]
[ClientPropertyName("rated")]
public string OnClientRated { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is an empty string.

Two parameters are passed to the handler:

sender, the RadRating object that raised the event.
args.

This event cannot be cancelled.

Example:

The following example demonstrates how to use the <strong>OnClientRated</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientRated(sender, args)<br />
         {<br />
             var ratingControl = sender;<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;telerik:RadRating ID="RadRating1" runat="server"<br />
        <strong>OnClientRated="OnClientRated"</strong>&gt;<br />
        ....<br />
        &lt;/telerik:RadRating&gt;
    </div>
</p>

OnClientRating

string

Gets or sets a value indicating the client-side event handler that is called when the user clicks an item (star) of the RadRating control, but before the new value is set.

[ClientControlEvent]
[ClientPropertyName("rating")]
public string OnClientRating { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is an empty string.

Two parameters are passed to the handler:

sender, the RadRating object that raised the event.
args.

This event can be cancelled.

Example:

The following example demonstrates how to use the <strong>OnClientRating</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientRating(sender, args)<br />
         {<br />
             var ratingControl = sender;<br />
             args.set_cancel(true);
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;telerik:RadRating ID="RadRating1" runat="server"<br />
        <strong>OnClientRating="OnClientRating"</strong>&gt;<br />
        ....<br />
        &lt;/telerik:RadRating&gt;
    </div>
</p>

Orientation

Get/Set the orientation of the RadRating control.

[ClientControlProperty]
public Orientation Orientation { get; set; }

Precision

RatingPrecision

Get/Set the rating precision for the RadRating control - the precision with which the user can rate.

[ClientControlProperty]
public RatingPrecision Precision { get; set; }

ReadOnly

bool

Get/Set a value indicating whether the RadRating control is in read-only mode.

[ClientControlProperty]
[ClientPropertyName("readOnly")]
public bool ReadOnly { get; set; }

SelectedItem

RadRatingItem

Gets a RadRatingItem object that represents the selected item in the RadRating control in case Items collection of the control is not empty.

[Browsable(false)]
public RadRatingItem SelectedItem { get; }

Property Value:

A RadRatingItem object that represents the selected item. If there are no items in the Items collection of the RadRating control, returns null.

SelectedItems

RadRatingItemCollection

Gets a RadRatingItemCollection object that contains the selected items in the RadRating control. The collection is empty in case there are no items in the Items collection of the control.

[Browsable(false)]
public RadRatingItemCollection SelectedItems { get; }

Property Value:

A RadRatingItemCollection containing the selected items.

SelectionMode

RatingSelectionMode

Get/Set the selection mode for the RadRating control - when the user rates, either mark a single item (star) as selected or all items(stars) from the first to the selected one.

[ClientControlProperty]
public RatingSelectionMode SelectionMode { get; set; }

TagKey

HtmlTextWriterTag

protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

Value

decimal

Get/Set the current rating for the RadRating control.

public decimal Value { get; set; }

Methods

AddAttributesToRender(HtmlTextWriter)

Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.

protected override void AddAttributesToRender(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

A HtmlTextWriter that represents the output stream to render HTML content on the client.

Overrides: RadDataBoundControl.AddAttributesToRender(HtmlTextWriter)

BindToEnumerableData(IEnumerable)

Binds the Rating control to a IEnumerable data source

public void BindToEnumerableData(IEnumerable dataSource)

Parameters:dataSourceIEnumerable

IEnumerable data source

ControlPreRender()

Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason

protected override void ControlPreRender()

Overrides: RadDataBoundControl.ControlPreRender()

DescribeClientEvents(IScriptDescriptor)

protected override void DescribeClientEvents(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadDataBoundControl.DescribeClientEvents(IScriptDescriptor)

DescribeClientProperties(IScriptDescriptor)

protected override void DescribeClientProperties(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadDataBoundControl.DescribeClientProperties(IScriptDescriptor)

DescribeComponent(IScriptDescriptor)

protected override void DescribeComponent(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadDataBoundControl.DescribeComponent(IScriptDescriptor)

FindItemByValue(decimal)

public RadRatingItem FindItemByValue(decimal value)

Parameters:valuedecimalReturns:

RadRatingItem

LoadClientState(Dictionary<string, object>)

Loads the client state data

protected override void LoadClientState(Dictionary<string, object> clientState)

Parameters:clientStateDictionary<string, object>

Overrides: RadDataBoundControl.LoadClientState(Dictionary<string, object>)

LoadPostData(string, NameValueCollection)

Executed when post data is loaded from the request

protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)

Parameters:postDataKeystringpostCollectionNameValueCollectionReturns:

bool

Overrides: RadDataBoundControl.LoadPostData(string, NameValueCollection)

LoadViewState(object)

protected override void LoadViewState(object savedState)

Parameters:savedStateobject

Overrides: DataBoundControl.LoadViewState(object)

OnItemCreated(RatingEventArgs)

Executed right after the item is created and inserted in the Rating Items collection.

protected virtual void OnItemCreated(RatingEventArgs e)

Parameters:eRatingEventArgs

OnItemDataBound(RatingEventArgs)

Executed right after the item is data-bound to the data source.

protected virtual void OnItemDataBound(RatingEventArgs e)

Parameters:eRatingEventArgs

OnRate(EventArgs)

Gets or sets a value indicating the server-side event handler that is called when the current rating of the RadRating control changes.

protected virtual void OnRate(EventArgs e)

Parameters:eEventArgs

Two parameters are passed to the handler:

sender, the RadRating object that raised the event.
args.

Example:

The following example demonstrates how to use the <strong>OnRate</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;telerik:RadRating ID="RadRating1" runat= "server"<br />
        <strong>OnRate="OnRate" AutoPostBack="true"</strong>&gt;<br />
        ....<br />
        &lt;/telerik:RadRating&gt;
    </div>
</p>

PerformDataBinding(IEnumerable)

protected override void PerformDataBinding(IEnumerable data)

Parameters:dataIEnumerable

Overrides: DataBoundControl.PerformDataBinding(IEnumerable)

PrepareForDataBinding()

protected void PrepareForDataBinding()

RaisePostBackEvent(string)

public void RaisePostBackEvent(string eventArgument)

Parameters:eventArgumentstring

Implements: IPostBackEventHandler.RaisePostBackEvent(string)

RaisePostDataChangedEvent()

Executed when post data changes should invoke a changed event

protected override void RaisePostDataChangedEvent()

Overrides: RadDataBoundControl.RaisePostDataChangedEvent()

RenderContents(HtmlTextWriter)

protected override void RenderContents(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadDataBoundControl.RenderContents(HtmlTextWriter)

SaveViewState()

protected override object SaveViewState()

Returns:

object

Overrides: DataBoundControl.SaveViewState()

TrackViewState()

protected override void TrackViewState()

Overrides: DataBoundControl.TrackViewState()

Events

ItemCreated

EventHandler<RatingEventArgs>

Adds or removes an event handler method from the ItemDataBound event. Fired after a rating item is created and inserted in the Rating Items collection.

public virtual event EventHandler<RatingEventArgs> ItemCreated

ItemDataBound

EventHandler<RatingEventArgs>

Adds or removes an event handler method from the ItemDataBound event. Fired after a rating item (star) is data bound.

public virtual event EventHandler<RatingEventArgs> ItemDataBound

Rate

EventHandler

Adds or removes an event handler method from the Rate event. Fired after a rating item (star) is clicked.

public virtual event EventHandler Rate