ASPxTabControlBase.ActiveTabIndex Property

Gets or sets the index of a tab (tabbed page) which is selected within the control.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v18.2.dll

Declaration

C#

[DefaultValue(-1)]
public int ActiveTabIndex { get; set; }

VB.NET

<DefaultValue(-1)>
Public Property ActiveTabIndex As Integer

Property Value

Type	Default	Description
Int32	-1	An integer value specifying the index of an active tab (tabbed page) within the control’s ASPxTabControl.Tabs (ASPxPageControl.TabPages) collection.

Remarks

A tab control (which can be either the ASPxTabControl or ASPxPageControl) allows end users to select tabs via mouse clicks. In order to make a particular tab (tabbed page) active via code use the ActiveTabIndex property. This property specifies the active tab’s index within the ASPxTabControl.Tabs (ASPxPageControl.TabPages) collection of a tab control.

Note that a tab control always has an active tab and only one tab can be active within a tab control at a time.

You can also use the ASPxTabControl.ActiveTab (ASPxPageControl.ActiveTabPage) property to access and change an active tab (tabbed page) within a tab control.

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>
...

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ActiveTabIndex 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#

how-to-dynamically-add-and-remove-controls-within-aspxcallbackpanel-on-callbacks-e4113/CS/WebSite/Default.aspx.cs#L44

CreateTab(tabId, tabType);
PageControl.ActiveTabIndex = PageControl.TabPages.Count - 1;

how-to-display-master-detail-tables-in-two-grids-on-separate-tabs-of-a-pagecontrol-e1285/CS/SeparateGridsOnTabPages/Default.aspx.cs#L26

    // go to the next tab
    ASPxPageControl1.ActiveTabIndex = 1;
}

VB.NET

how-to-dynamically-add-and-remove-controls-within-aspxcallbackpanel-on-callbacks-e4113/VB/WebSite/Default.aspx.vb#L46

CreateTab(tabId, tabType)
PageControl.ActiveTabIndex = PageControl.TabPages.Count - 1

how-to-display-master-detail-tables-in-two-grids-on-separate-tabs-of-a-pagecontrol-e1285/VB/SeparateGridsOnTabPages/Default.aspx.vb#L28

    ' go to the next tab
    ASPxPageControl1.ActiveTabIndex = 1
End Sub