We are updating the DevExpress product documentation website and this page is part of our new experience. During this transition period, product documentation remains available in our previous format at documentation.devexpress.com. Learn More...
V
18.2
18.2
18.1
17.2
All docs
General Information
.NET Subscription
Desktop
Web
Code / Debug / Refactor
Frameworks and Libraries
IOS, Android & Xamarin
All docs
V18.2
General Information
.NET Subscription
Desktop
Web
Code / Debug / Refactor
Frameworks and Libraries
IOS, Android & Xamarin
18.2
18.1
17.2
DashboardLayoutGroup Class
A layout group used to arrange layout items or other groups within a dashboard.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v18.2.Core.dll
Declaration
public class DashboardLayoutGroup :
DashboardLayoutNode,
IDashboardLayoutNodePublic Class DashboardLayoutGroup
Inherits DashboardLayoutNode
Implements IDashboardLayoutNodeThe DashboardLayoutGroup class exposes the DashboardLayoutGroup.ChildNodes property that provides access to the collection of child layout groups and items that constitute the current layout group. Use the DashboardLayoutGroup.Orientation property to specify the orientation of layout items/groups within the group.
The DashboardLayoutGroup.Weight property allows specifying the relative size of the layout group.
Examples
The following example demonstrates how to modify dashboard layout in code.
In this example, the DashboardViewer loads a dashboard containing three dashboard items placed vertically, one above the other. The following steps are taken to create a new layout:
- Three DashboardLayoutItem objects are created to display the existing dashboard items. The weight parameter specifies the layout item's relative size.
- A new DashboardLayoutGroup is created to display two dashboard items. The Orientation parameter specifies how layout items are placed within the group.
- A root layout group is created. This group contains the previously created group and another layout item.
- The root layout group is assigned to the LayoutRoot property.
This example also demonstrates how to swap layout items using the MoveRight(DashboardLayoutNode) method, save and restore the layout using the SaveDashboardLayout(String) and LoadDashboardLayout(String) methods.
Note
The complete sample project How to modify dashboard layout in code is available in the DevExpress Examples repository.
private void ChangeLayout(DashboardToolbarItemClickEventArgs args)
{
Dashboard dashboard = new Dashboard();
dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");
dashboard.BeginUpdate();
// Create layout items used to display dashboard items.
DashboardLayoutItem item0 = new DashboardLayoutItem(dashboard.Items[0], 35);
DashboardLayoutItem item1 = new DashboardLayoutItem(dashboard.Items[1], 65);
DashboardLayoutItem item2 = new DashboardLayoutItem(dashboard.Items[2], 20);
// Create a layout group that contains two layout items.
DashboardLayoutGroup group1 =
new DashboardLayoutGroup(DashboardLayoutGroupOrientation.Horizontal, 80,
item0, item1);
// Create a root layout group that contains the previously created group and
// another layout item.
DashboardLayoutGroup rootGroup =
new DashboardLayoutGroup(DashboardLayoutGroupOrientation.Vertical, 1,
group1, item2);
// Applies the layout to the dashboard.
dashboard.LayoutRoot = rootGroup;
dashboard.EndUpdate();
dashboardViewer1.Dashboard = dashboard;
}
private void RepositionItems(DashboardToolbarItemClickEventArgs args)
{
Dashboard dashboard = dashboardViewer1.Dashboard;
DashboardLayoutGroup rootGroup = dashboard.LayoutRoot.ChildNodes[0] as DashboardLayoutGroup;
if ((rootGroup != null) && (rootGroup.ChildNodes.Count > 1))
rootGroup.ChildNodes[0].MoveRight(rootGroup.ChildNodes[1]);
}
private void SaveLayoutToFile(DashboardToolbarItemClickEventArgs args)
{
dashboardViewer1.SaveDashboardLayout("DashboardLayout.xml");
}
private void LoadLayoutFromFile(DashboardToolbarItemClickEventArgs obj)
{
if (File.Exists("DashboardLayout.xml"))
dashboardViewer1.LoadDashboardLayout("DashboardLayout.xml");
}
Private Sub ChangeLayout(ByVal args As DashboardToolbarItemClickEventArgs)
Dim dashboard As New Dashboard()
dashboard.LoadFromXml("..\..\Data\Dashboard.xml")
dashboard.BeginUpdate()
' Create layout items used to display dashboard items.
Dim item0 As New DashboardLayoutItem(dashboard.Items(0), 35)
Dim item1 As New DashboardLayoutItem(dashboard.Items(1), 65)
Dim item2 As New DashboardLayoutItem(dashboard.Items(2), 20)
' Create a layout group that contains two layout items.
Dim group1 As New DashboardLayoutGroup(DashboardLayoutGroupOrientation.Horizontal, 80, item0, item1)
' Create a root layout group that contains the previously created group and
' another layout item.
Dim rootGroup As New DashboardLayoutGroup(DashboardLayoutGroupOrientation.Vertical, 1, group1, item2)
' Applies the layout to the dashboard.
dashboard.LayoutRoot = rootGroup
dashboard.EndUpdate()
dashboardViewer1.Dashboard = dashboard
End Sub
Private Sub RepositionItems(ByVal args As DashboardToolbarItemClickEventArgs)
Dim dashboard As Dashboard = dashboardViewer1.Dashboard
Dim rootGroup As DashboardLayoutGroup = TryCast(dashboard.LayoutRoot.ChildNodes(0), DashboardLayoutGroup)
If (rootGroup IsNot Nothing) AndAlso (rootGroup.ChildNodes.Count > 1) Then
rootGroup.ChildNodes(0).MoveRight(rootGroup.ChildNodes(1))
End If
End Sub
Private Sub SaveLayoutToFile(ByVal args As DashboardToolbarItemClickEventArgs)
dashboardViewer1.SaveDashboardLayout("DashboardLayout.xml")
End Sub
Private Sub LoadLayoutFromFile(ByVal obj As DashboardToolbarItemClickEventArgs)
If File.Exists("DashboardLayout.xml") Then
dashboardViewer1.LoadDashboardLayout("DashboardLayout.xml")
End If
End Sub
Inheritance
See Also
give feedback
Was this topic helpful?
Did it help answer your question?
Did it help answer your question?