ASPxTabControlBase.ClientInstanceName Property

Gets or sets the ASPxTabControlBase‘s client programmatic identifier.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v20.2.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 ASPxTabControlBase‘s client identifier.

Remarks

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

Note

The client-side programmatic interface is available if the ASPxTabControlBase.EnableClientSideAPI property is set to true.

Example

The complete sample project is available in the DevExpress Code Central database at E483.

ASPX

...
         <dxtc:ASPxPageControl ID="ASPxPageControl1" runat="server" 
         ActiveTabIndex="0" ClientInstanceName="pageControl">
             <TabPages>
                 <dxtc:TabPage Text="Tab 1">
                     <ContentCollection>
                         <dxw:ContentControl runat="server">
                          <dxe:ASPxCheckBox ID="ASPxCheckBox1" runat="server" Text="Show Tab 2">
                                 <ClientSideEvents CheckedChanged="function(s, e) {
                var tab = pageControl.GetTab(1);
                var isVisible = s.GetChecked();
                tab.SetVisible(isVisible);
                }" />
                             </dxe:ASPxCheckBox>
                         </dxw:ContentControl>
                     </ContentCollection>
                 </dxtc:TabPage>
                 <dxtc:TabPage ClientVisible="False" Text="Tab 2">
                     <ContentCollection>
                         <dxw:ContentControl runat="server">
                             <dxe:ASPxLabel ID="ASPxLabel1" runat="server" Text="Label on Tab 2">
                             </dxe:ASPxLabel>
                         </dxw:ContentControl>
                     </ContentCollection>
                 </dxtc:TabPage>
             </TabPages>
         </dxtc:ASPxPageControl>
...