ASPxButton.ClientInstanceName Property

Specifies the ASPxButton‘s client programmatic identifier.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.1.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	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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ClientInstanceName property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

aspxgridview-show-a-modal-popup-using-the-control-in-detailrowtemplatecontainer-e1067/CS/DetailPopup/Default.aspx.cs#L33

ASPxButton bt = ((ASPxGridView)sender).FindRowCellTemplateControl(e.VisibleIndex, col, "ASPxButton2") as ASPxButton;
bt.ClientInstanceName = "button" + e.VisibleIndex.ToString();
Session["ProductID"] = val;

VB.NET

aspxgridview-show-a-modal-popup-using-the-control-in-detailrowtemplatecontainer-e1067/VB/DetailPopup/Default.aspx.vb#L29

Dim bt As ASPxButton = TryCast((CType(sender, ASPxGridView)).FindRowCellTemplateControl(e.VisibleIndex, col, "ASPxButton2"), ASPxButton)
bt.ClientInstanceName = "button" & e.VisibleIndex.ToString()
Session("ProductID") = val