ASPxDockManager.ClientInstanceName Property

Gets or sets the ASPxDockManager‘s client programmatic identifier.

Assembly : DevExpress.Web.v25.2.dll

Declaration

C#
VB.NET

csharp

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

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

Property Value

Type	Default	Description
String	String.Empty

A string value that specifies the ASPxDockManager‘s client identifier.

Remarks

Use the ClientInstanceName property to specify a unique client-side identifier for the ASPxDockManager control. The ClientInstanceName property’s value can be used on the client side to programmatically access the client object rendered for the ASPxDockManager control in client-side script. This property is particularly important in referencing the ASPxDockManager 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.

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.

aspx

<dx:ASPxTextBox ... ClientInstanceName="SomeType.SomeProp" />

var txt = ASPxClientControl.GetControlCollection().GetByName("SomeType.SomeProp");  
txt.SetText("Some Text");

Example

The code sample below demonstrates how you can get a list of docked panels contained within a page.

JS
ASPX

javascript

function IsDockedPredicate (panel) {
     return panel.IsDocked();
}

function GetDockedPanelsList () {
     var DockedPanels = manager.GetPanels(IsDockedPredicate);
     var PanelList = '';
     for ( i=0; i < DockedPanels.length; i++){
          PanelList = PanelList + ' ' + DockedPanels[i].panelUID;
     }
     label.SetText('Docked panels:' + PanelList);
}

aspx

<dx:ASPxDockManager ID="MyASPxDockManager" runat="server" ClientInstanceName="manager">
</dx:ASPxDockManager>

<dx:ASPxLabel ID="MyASPxLabel" runat="server" Text="Docked panels:" ClientInstanceName="label">
</dx:ASPxLabel>