Skip to main content

ASPxPopupControlBase.ClientInstanceName Property

Specifies the ASPxPopupControl‘s or ASPxDockPanel‘s client programmatic identifier.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v23.1.dll

NuGet Package: DevExpress.Web


public string ClientInstanceName { get; set; }

Property Value

Type Default Description
String String.Empty

A control’s client identifier.


Use the ClientInstanceName property to specify a unique client-side identifier for the ASPxPopupControl/ASPxDockPanel control. Use this identifier on the client side to programmatically access the ASPxClientPopupControl/ASPxClientDockPanel object.

The ClientInstanceName property is important when a control is contained in a naming container, for instance, in an ASPxPageControl‘s page.

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 in a naming container.


     function click(s, e) {
<dx:ASPxButton ID="ShowButton" runat="server" Text="Show Popup Window" AutoPostBack="False"/>

<dx:ASPxPopupControl ID="PopupControl" runat="server" ClientInstanceName="ClientPopupControl" LoadContentViaCallback="OnFirstShow" 
          PopupElementID="ShowButton" ShowFooter="True" Width="310px" Height="160px" HeaderText="Updatable content" >
          <dx:PopupControlContentControl ID="PopupControlContentControl" runat="server">
               The content of this popup control was updated at<br /> <b> <%= DateTime.Now.ToLongTimeString() %></b>
          <dx:ASPxButton ID="UpdateButton" runat="server" Text="Update Content" AutoPostBack="False">
               <ClientSideEvents Click="click" />

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");  
See Also