TabBase.Visible Property

Gets or sets a value specifying the visibility of the current tab (tab page).

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue(true)]
public bool Visible { get; set; }

VB.NET

<DefaultValue(True)>
Public Property Visible As Boolean

Property Value

Type	Default	Description
Boolean	true	true if the tab is visible; otherwise false

Remarks

Use the Visible property of tabs (tab pages) to dynamically change the content of a tab control (page control). This property enables you to hide and display specific tabs (tab pages) when certain conditions are met.

Note that the Visible and TabBase.VisibleIndex properties are interdependent. A false value assigned to the Visible property sets the TabBase.VisibleIndex property to -1. Setting the Visible property back to true sets the TabBase.VisibleIndex property to the non-negative value it previously had.

Note

If you toggle a tab page’s Visible property via code, it changes the control’s child controls hierarchy. In this case, you should set the ASPxPageControl.EnableHierarchyRecreation property to true; otherwise, the ASPxPageControl may function improperly.

Note

If a tab’s server Visible property is set to false, the tab is not rendered into the web page at all, so it can’t be manipulated on the client side.

Example

The following example shows how the tab page's visibility can be changed via code. Note that the EnableHierarchyRecreation property should be set to true.

Note

To change a tab page’s visibility use the TabBase.Visible property rather than modification the tab page collection using TabPageCollection.Add, TabPageCollection.Remove, or Collection.RemoveAt methods.

Default.aspx.cs

protected void Page_Load(object sender, EventArgs e)
{
    // Initially hide the second tab page
    if (!IsPostBack && !IsCallback) {
        ASPxPageControl1.TabPages[1].Visible = false; // do not use  ASPxPageControl1.TabPages.RemoveAt(1)!
    }

}
protected void ASPxRadioButtonList1_SelectedIndexChanged(object sender, EventArgs e) {
    // Hide a tab page corresponding to the selected radio button
    for (int i = 0; i < ASPxPageControl1.TabPages.Count; i++) {
        ASPxPageControl1.TabPages[i].Visible = true;
    }
    ASPxPageControl1.TabPages[ASPxRadioButtonList1.SelectedIndex].Visible = false;

}

Default.aspx.vb

Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    If (Not IsPostBack) AndAlso (Not IsCallback) Then
        ASPxPageControl1.TabPages(1).Visible = False ' do not use ASPxPageControl1.TabPages.RemoveAt(1)!
    End If

End Sub
Protected Sub ASPxRadioButtonList1_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs)
    For i As Integer = 0 To ASPxPageControl1.TabPages.Count - 1
        ASPxPageControl1.TabPages(i).Visible = True
    Next i
    ASPxPageControl1.TabPages(ASPxRadioButtonList1.SelectedIndex).Visible = False

End Sub

Default.aspx

<dx:ASPxPageControl ID="ASPxPageControl1" runat="server" ActiveTabIndex="1" EnableHierarchyRecreation="True" >
    <TabPages>
        <dx:TabPage Text="Tab 1">
            <ContentCollection>
                <dx:ContentControl runat="server">
                    Page 1 Content
                </dx:ContentControl>
            </ContentCollection>
        </dx:TabPage>
        <dx:TabPage Text="Tab 2">
            <ContentCollection>
                <dx:ContentControl runat="server">
                    Page 2 Content
                </dx:ContentControl>
            </ContentCollection>
        </dx:TabPage>
    </TabPages>
</dx:ASPxPageControl>
<br />
Select page to hide<br />
<dx:ASPxRadioButtonList ID="ASPxRadioButtonList1" runat="server" SelectedIndex="1" AutoPostBack="True" OnSelectedIndexChanged="ASPxRadioButtonList1_SelectedIndexChanged">
    <Items>
        <dx:ListEditItem Text="Page 1" Value="Page 1" />
        <dx:ListEditItem Text="Page 2" Value="Page 2" />
    </Items>
</dx:ASPxRadioButtonList>
<br />
<dx:ASPxButton ID="ASPxButton1" runat="server" Text="PostBack">
</dx:ASPxButton>