Dashboard.Groups Property

Provides access to a collection of dashboard item groups.

Namespace : DevExpress.DashboardCommon

Assembly : DevExpress.Dashboard.v25.2.Core.dll

NuGet Package : DevExpress.Dashboard.Core

Declaration

• C#
• VB.NET

public DashboardItemGroupCollection Groups { get; }

Public ReadOnly Property Groups As DashboardItemGroupCollection

Property Value

A DashboardItemGroupCollection object representing a collection of DashboardItemGroup objects.

|

Remarks

A dashboard item group (the DashboardItemGroup object) arranges dashboard items within the Dashboard. It groups dashboard items into a separate layout group. Moreover, the dashboard item group provides the capability to affect interaction between dashboard items within and outside of the group.

A newly created dashboard item group should belong to the dashboard. To add a group to the dashboard, use the Groups property or create a new group using the Dashboard.CreateGroup method.

To add or remove dashboard items to/from the group, use the DashboardItemGroup.Add/DashboardItemGroup.Remove methods. The DashboardItemGroup.Items property provides access to dashboard items contained within the current group.

To access interactivity settings for the specified DashboardItemGroup, use the DashboardItemGroup.InteractivityOptions property. The DashboardItemGroupInteractivityOptions object returned by this property exposes the following members.

• The DashboardItemGroupInteractivityOptions.IsMasterFilter property provides the capability to filter external dashboard items using master filter items contained within the specified dashboard item group. If this property is set to false , master filter items contained within the group can filter only dashboard items from this group.
• The FilterableDashboardItemInteractivityOptions.IgnoreMasterFilters property allows you to isolate dashboard items contained within the group from being filtered using external master filter items.

Related GitHub Examples

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

winforms-dashboard-designer-merge-dashboards-to-tabs/CS/DashboardMerger/ItemsMerger.cs#L9

public static void MergeGroups(DashboardItemGroupCollection fromGroups, DashboardMerger dashboardMerger) {
    DashboardItemGroupCollection toGroups = dashboardMerger.TargetDashboard.Groups;
    IList<DashboardItem> newItems = dashboardMerger.NewItems;

winforms-dashboard-create-layout-from-scratch/CS/Dashboard_LayoutCustomization/Form1.cs#L36

Orientation = DashboardLayoutGroupOrientation.Vertical,
DashboardItem = dashboard.Groups["dashboardItemGroup1"],
Weight = 70

winforms-dashboard-designer-merge-dashboards-to-tabs/VB/DashboardMerger/ItemsMerger.vb#L13

Public Shared Sub MergeGroups(ByVal fromGroups As DashboardItemGroupCollection, ByVal dashboardMerger As DashboardMerger)
    Dim toGroups As DashboardItemGroupCollection = dashboardMerger.TargetDashboard.Groups
    Dim newItems As IList(Of DashboardItem) = dashboardMerger.NewItems

winforms-dashboard-create-layout-from-scratch/VB/Dashboard_LayoutCustomization/Form1.vb#L31

' Create a layout item for the dashboard Group item.
Dim groupLayoutItem As New DashboardLayoutGroup() With {.Orientation = DashboardLayoutGroupOrientation.Vertical, .DashboardItem = dashboard.Groups("dashboardItemGroup1"), .Weight = 70}
' Connect layout items in the layout tree.

See Also

Dashboard Class

Dashboard Members

DevExpress.DashboardCommon Namespace