ASPxButton.ClientInstanceName Property

Specifies the ASPxButton‘s client programmatic identifier.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
String	String.Empty	The control’s client identifier.

Remarks

Use the ClientInstanceName property to specify a unique client-side identifier for the ASPxButton control. Use this identifier on the client side to access the ASPxClientButton object programmatically.

Example

ASPX

<script>
     function onCheckedChanged(s, e) {
          if (s.GetChecked()) {
               button.SetEnabled(false);
               s.SetText("Enable Button");
          } else {
               button.SetEnabled(true);
               s.SetText("Disable Button");
          }
     }
</script>
<dx:ASPxButton ID="ASPxButton1" runat="server" AutoPostBack="False" GroupName="G" Text="Disable Button">
     <ClientSideEvents CheckedChanged="onCheckedChanged" />
</dx:ASPxButton>
<dx:ASPxButton ID="ASPxButton2" runat="server" AutoPostBack="False" ClientInstanceName="button" Text="Button">
</dx:ASPxButton>

The ClientInstanceName property is important when a control 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");