ASPxNavBar.ActiveGroup Property

Gets or sets the active group within the navbar control.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.2.dll

Declaration

C#

public NavBarGroup ActiveGroup { get; set; }

VB.NET

Public Property ActiveGroup As NavBarGroup

Property Value

Type	Description
NavBarGroup	A NavBarGroup object that represents the active group.

Remarks

When the ASPxNavBar.AutoCollapse property of a navbar control is set to true, only one group can be expanded within the navbar at a time. This single expanded group is called the navbar’s active group. In this mode, the ActiveGroup property can be used to obtain and specify the active group within the navbar control.

Note that if the ASPxNavBar.AutoCollapse property is set to false, the ActiveGroup property is not in effect and returns null (Nothing in Visual Basic).

Example

The code sample below demonstrates how to populate an ASPxNavBar control with groups and items manually, in unbound mode. The image below shows the result.

C#

protected void Page_Load(object sender, EventArgs e) {
     if (!IsPostBack) {
            CreateNavBar();
     }
}

//Create NavBar initial structure. 
void CreateNavBar() {
     string[] GroupTexts = { "Home", "News", "Products", "Client Center" };
     foreach (string Text in GroupTexts) {
          MyASPxNavBar.Groups.Add(Text);
     }
     MyASPxNavBar.Groups.FindByText("News").Items.Add("Subscriptions");
     NavBarItem[] ProductsItems = { 
          new NavBarItem("Downloads"), 
          new NavBarItem("Support"), 
          new NavBarItem("Order") 
     };
     MyASPxNavBar.Groups.FindByText("Products").Items.Add(ProductsItems);
}

//Add a new group
protected void btnAddGroup_Click(object sender, EventArgs e) {
     if (tbItemName.Text != "") {
          MyASPxNavBar.Groups.Add(tbItemName.Text);
     }
}

//Add a new item
     protected void btnAddItem_Click(object sender, EventArgs e) {
        if ((MyASPxNavBar.ActiveGroup != null) && (tbItemName.Text != "")) {
            MyASPxNavBar.ActiveGroup.Items.Add(tbItemName.Text);
     }
}

VB.NET

Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
     If (Not IsPostBack) Then
          CreateNavBar()
     End If
End Sub

'Create NavBar initial structure. 
Private Sub CreateNavBar()
     Dim GroupTexts() As String = { "Home", "News", "Products", "Client Center" }
     For Each Text As String In GroupTexts
          MyASPxNavBar.Groups.Add(Text)
     Next Text
     MyASPxNavBar.Groups.FindByText("News").Items.Add("Subscriptions")
     Dim ProductsItems() As NavBarItem = { New NavBarItem("Downloads"), New NavBarItem("Support"), New NavBarItem("Order") }
     MyASPxNavBar.Groups.FindByText("Products").Items.Add(ProductsItems)
End Sub

'Add a new group
Protected Sub btnAddGroup_Click(ByVal sender As Object, ByVal e As EventArgs)
     If tbItemName.Text <> "" Then
          MyASPxNavBar.Groups.Add(tbItemName.Text)
     End If
End Sub

'Add a new item
Protected Sub btnAddItem_Click(ByVal sender As Object, ByVal e As EventArgs)
     If (MyASPxNavBar.ActiveGroup IsNot Nothing) AndAlso (tbItemName.Text <> "") Then
          MyASPxNavBar.ActiveGroup.Items.Add(tbItemName.Text)
     End If
End Sub

ASPX

<dx:ASPxNavBar ID="MyASPxNavBar" runat="server" AutoCollapse="True">
</dx:ASPxNavBar>
<dx:ASPxTextBox ID="tbItemName" runat="server" Width="170px">
</dx:ASPxTextBox>
<table>
     <tr>
          <td>
               <dx:ASPxButton ID="btnAddGroup" runat="server" onclick="btnAddGroup_Click" Text="Add Group">
               </dx:ASPxButton>
          </td>
          <td>
               <dx:ASPxButton ID="btnAddItem" runat="server" onclick="btnAddItem_Click" Text="Add Item">
               </dx:ASPxButton>
          </td>
     </tr>
</table>