ASPxLoadingPanel.ClientInstanceName Property

Gets or sets the ASPxLoadingPanel‘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	A string value that specifies the ASPxLoadingPanel‘s client identifier.

Remarks

Use the ClientInstanceName property to specify a unique client-side identifier for the ASPxLoadingPanel control. The ClientInstanceName property’s value can be used on the client side to programmatically access the client object rendered for the ASPxLoadingPanel control in client-side script. This property is particularly important in referencing the ASPxLoadingPanel control when it is contained within a naming container (for example, 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.

ASPX

<dx:ASPxLoadingPanel ID="ASPxLoadingPanel1" runat="server"
  ClientInstanceName="lPanel" ContainerElementID="myDiv" Modal="True" ...>
</dx:ASPxLoadingPanel>

<div style="width:500px; height:300px; border: 1px solid red;" id="myDiv">
TEST
</div>
<dx:ASPxButton ID="ASPxButton1" runat="server" Text="ASPxButton" 
    AutoPostBack="False">
    <ClientSideEvents Click="function(s, e) {
          lPanel.Show();
    }" />
</dx:ASPxButton>

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