Tab
A newer version of this page is available. Switch to the current version.

ASPxButton.ClientInstanceName Property

Specifies the ASPxButton's client programmatic identifier.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v18.2.dll

Declaration

[DefaultValue("")]
public string ClientInstanceName { get; set; }
<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

<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.

See Also