BarBaseButtonItem.GroupIndex Property

Gets or sets the button’s group index. This property is in effect when the current object acts as a check button.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v20.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(0)]
public virtual int GroupIndex { get; set; }

VB.NET

<DefaultValue(0)>
Public Overridable Property GroupIndex As Integer

Property Value

Type	Default	Description
Int32	0	The button’s group index.

Remarks

The GroupIndex property allows you to create a radio group of check buttons. When a user selects one item, other items in the group are automatically deselected.

The GroupIndex property is in effect for BarBaseButtonItems that act like check buttons. These items include the following:

• BarCheckItems
• BarButtonItem objects, whose BarButtonItem.ButtonStyle property is set to BarButtonStyle.Check.

To combine two or more check buttons in a radio group, set the GroupIndex property for these buttons to the same non-zero value.

The BarBaseButtonItem.AllowAllUp property determines if all items in a group can be deselected simultaneously.

Example

The following code combines two BarCheckItems in a radio group.

C#

private void Form1_Load(object sender, EventArgs e) {
    int colorRadioGroupValue1 = 11;

    barCheckItem1.Caption = "Black";
    barCheckItem1.CheckBoxVisibility = CheckBoxVisibility.BeforeText;
    barCheckItem1.CheckStyle = BarCheckStyles.Radio;
    barCheckItem1.GroupIndex = colorRadioGroupValue1;
    barCheckItem1.CheckedChanged += BarCheckItem_CheckedChanged;

    barCheckItem2.Caption = "White";
    barCheckItem2.CheckBoxVisibility = CheckBoxVisibility.BeforeText;
    barCheckItem2.CheckStyle = BarCheckStyles.Radio;
    barCheckItem2.GroupIndex = colorRadioGroupValue1;
    barCheckItem2.CheckedChanged += BarCheckItem_CheckedChanged;
    barCheckItem2.Checked = true;
}

private void BarCheckItem_CheckedChanged(object sender, ItemClickEventArgs e) {
    BarCheckItem checkItem = sender as BarCheckItem;
    MessageBox.Show(checkItem.Caption);
}

VB.NET

Private Sub Form1_Load(sender As Object, e As EventArgs) Handles MyBase.Load
    Dim colorRadioGroupValue1 As Integer = 11

    BarCheckItem1.Caption = "Black"
    BarCheckItem1.CheckBoxVisibility = CheckBoxVisibility.BeforeText
    BarCheckItem1.CheckStyle = BarCheckStyles.Radio
    BarCheckItem1.GroupIndex = colorRadioGroupValue1
    AddHandler BarCheckItem1.CheckedChanged, AddressOf BarCheckItem_CheckedChanged

    BarCheckItem2.Caption = "White"
    BarCheckItem2.CheckBoxVisibility = CheckBoxVisibility.BeforeText
    BarCheckItem2.CheckStyle = BarCheckStyles.Radio
    BarCheckItem2.GroupIndex = colorRadioGroupValue1
    AddHandler BarCheckItem2.CheckedChanged, AddressOf BarCheckItem_CheckedChanged
    BarCheckItem2.Checked = True
End Sub

Private Sub BarCheckItem_CheckedChanged(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    Dim checkItem As BarCheckItem = TryCast(sender, BarCheckItem)
    MessageBox.Show(checkItem.Caption)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GroupIndex 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-implement-a-context-menu-allowing-to-activate-a-certain-dockpanel-in-a-tabbed-group-e2676/CS/WindowsFormsApplication1/Form1.cs#L17

BarCheckItem item = new BarCheckItem();
item.GroupIndex = 1;
item.Caption = panel.Text;

lesson-5-complex-navigation-in-mvpvm-application-t136053/CS/MvpvmNavigation/Form1.cs#L73

biModule.Name = "biModule" + ViewModel.GetName(moduleType);
biModule.GroupIndex = 1;
biModule.BindCommand((t) => ViewModel.SelectModule(t), ViewModel, () => moduleType);

lesson-6-multi-level-navigation-in-mvpvm-applications-t146514/CS/MvpvmNavigation/Form1.cs#L73

biModule.Name = "biModule" + ViewModel.GetName(moduleType);
biModule.GroupIndex = 1;
biModule.BindCommand((t) => ViewModel.SelectModule(t), ViewModel, () => moduleType);

Reporting_how-to-sort-report-data-in-print-preview-by-using-a-drop-down-menu-t210208/CS/dxSampleGroupSort/SortReportTableHelpers/ReportColumnSortHelper.cs#L137

BarCheckItem item3 = Menu_InitSortItem(SortOrder.Descending);
item1.GroupIndex = item2.GroupIndex = item3.GroupIndex = 1;
sortMenu.AddItems(new BarItem[] { item1, item2, item3 });

VB.NET

Reporting_how-to-sort-report-data-in-print-preview-by-using-a-drop-down-menu-t210208/VB/dxSampleGroupSort/SortReportTableHelpers/ReportColumnSortHelper.vb#L38

Dim item3 As BarCheckItem = Menu_InitSortItem(SortOrder.Descending)
item3.GroupIndex = 1
item2.GroupIndex = item3.GroupIndex

how-to-implement-a-context-menu-allowing-to-activate-a-certain-dockpanel-in-a-tabbed-group-e2676/VB/WindowsFormsApplication1/Form1.vb#L19

Dim item As New BarCheckItem()
item.GroupIndex = 1
item.Caption = panel.Text

lesson-5-complex-navigation-in-mvpvm-application-t136053/VB/MvpvmNavigation/Form1.vb#L78

biModule.Name = "biModule" & ViewModel.GetName(moduleType)
biModule.GroupIndex = 1
biModule.BindCommand(Sub(t) ViewModel.SelectModule(t), ViewModel, Function() moduleType)

lesson-6-multi-level-navigation-in-mvpvm-applications-t146514/VB/MvpvmNavigation/Form1.vb#L78

biModule.Name = "biModule" & ViewModel.GetName(moduleType)
biModule.GroupIndex = 1
biModule.BindCommand(Sub(t) ViewModel.SelectModule(t), ViewModel, Function() moduleType)