ASPxRatingControl.ClientInstanceName Property

Gets or sets the ASPxRatingControl‘s client programmatic identifier.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.2.dll

Declaration

C#

[DefaultValue("")]
public string ClientInstanceName { get; set; }

VB.NET

<DefaultValue("")>
Public Property ClientInstanceName As String

Property Value

Type	Default	Description
String	String.Empty	A string value that specifies the ASPxRatingControl‘s client identifier.

Remarks

Use the ClientInstanceName property to specify a unique client-side identifier for the ASPxRatingControl control. The ClientInstanceName property’s value can be used on the client side to programmatically access the client object rendered for the ASPxRatingControl control in client-side script. This property is particularly important in referencing the ASPxRatingControl control when it is contained within a naming container (for instance, within an ASPxPageControl‘s page or an ASPxPopupControl‘s window).

If the ClientInstanceName property is not specified for a control, the control’s client identifier is generated automatically, and equals the value of the control’s ID property. Note that in this case, client-side programmatic access to the control is not allowed when the control is contained within a naming container.

Special Characters in Client Instance Name

If the ClientInstanceName property contains special characters, for instance, the dot (.), you cannot access a client object by this name. Call the GetByName(name) method to retrieve the client-side object instead.

<dx:ASPxTextBox ... ClientInstanceName="SomeType.SomeProp" />

var txt = ASPxClientControl.GetControlCollection().GetByName("SomeType.SomeProp");  
txt.SetText("Some Text");  

Example

This part of the Voting demo illustrates how to use the ASPxRatingControl.

Here, the ASPxRatingControl‘s read only status is enabled and disabled by using the ASPxClientRatingControl.SetReadOnly method within the ASPxRatingControl‘s ASPxClientRatingControl.ItemClick and ASPxCallback‘s ASPxClientCallback.CallbackComplete client events.

The ASPxRatingControl.ClientInstanceName property value is used to access the ASPxRatingControl on the client side.

C#

...
protected void cbVoting_Callback(object source, CallbackEventArgs e) {
    ...
    CurrentUserRatingValue = (int)ratingControl.Value;
    ...
}

JS

function RatingItemClick(s, e){
    ...
    ratingControl.SetReadOnly(true);
    cbVoting.PerformCallback();
}
function VotingCallbackComplete(s, e) {
    ...
    ratingControl.SetReadOnly(false);
}

ASPX

<dxrc:ASPxRatingControl ID="ratingControl" runat="server" ClientInstanceName="ratingControl">
    <ClientSideEvents ItemClick="RatingItemClick" />
</dxrc:ASPxRatingControl>
...
<dxcb:ASPxCallback ID="cbVoting" runat="server" ClientInstanceName="cbVoting" OnCallback="cbVoting_Callback">
    <ClientSideEvents CallbackComplete="VotingCallbackComplete" />
</dxcb:ASPxCallback>