DockLayoutManager.LayoutRoot Property

Gets or sets a root group for items (panels and other groups). This is a dependency property.

Namespace: DevExpress.Xpf.Docking

Assembly: DevExpress.Xpf.Docking.v24.1.dll

NuGet Package: DevExpress.Wpf.Docking

Declaration

C#

public LayoutGroup LayoutRoot { get; set; }

VB.NET

Public Property LayoutRoot As LayoutGroup

Property Value

Type	Description
LayoutGroup	A LayoutGroup object that represents the root group.

Remarks

The root group is the bottommost area to which items (panels and regular, tabbed and document groups) can be docked. You need to create a root group manually, assigning a LayoutGroup object to the LayoutRoot property.

The LayoutRoot property is marked with the ContentPropertyAttribute attribute. So, in XAML, the LayoutRoot property is initialized with the element declared between the start and end DockLayoutManager tags. Since a root group must be represented by a LayoutGroup object, the element declared between the start and end DockLayoutManager tags must be a LayoutGroup object.

A root group can contain LayoutPanel, LayoutGroup, TabbedGroup and DocumentGroup objects as children. The group’s children are arranged either horizontally or vertically, according to the LayoutGroup.Orientation property. They can be accessed via the LayoutGroup.Items property. This property is marked with the ContentPropertyAttribute attribute, so in XAML you can add elements to the group between the start and end LayoutGroup tags. To dock an item at a specific position in code, use the methods provided by the DockLayoutManager.DockController object.

Closed (hidden), auto-hidden and floating panels can never be children of the root group. To create these kinds of panels in XAML, use the DockLayoutManager.ClosedPanels, DockLayoutManager.AutoHideGroups and DockLayoutManager.FloatGroups collections. To create these panels in code, use the methods provided by the DockLayoutManager.DockController object.

For an example, see How to create a simple layout of dock panes.

Related GitHub Examples

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

XAML

wpf-docklayoutmanager-move-a-layout-item-in-code/CS/DockLayoutManager_MoveItem/Window1.xaml#L11

<dxdo:DockLayoutManager Name="dockLayoutManager1">
    <dxdo:DockLayoutManager.LayoutRoot>
        <dxdo:LayoutGroup Name="Root" Orientation="Vertical">

wpf-docklayoutmanager-load-an-external-window-or-usercontrol-into-a-documentpanel/CS/DocumentPanel_Content/MainWindow.xaml#L32

<dxdo:DockLayoutManager Name="dockLayoutManager1">
    <dxdo:DockLayoutManager.LayoutRoot>
        <dxdo:LayoutGroup>

wpf-docklayoutmanager-use-imvvmdockingproperties-to-build-dock-ui-with-mvvm/CS/MainWindow.xaml#L11

<dxdo:DockLayoutManager Name="dockLayoutManager1" DataContext="{StaticResource viewModel}" ItemsSource="{Binding ChildViews}">
    <dxdo:DockLayoutManager.LayoutRoot>
        <dxdo:LayoutGroup Caption="LayoutRoot" >

wpf-dock-layout-manager-pin-unpin-layout-panels-in-mvvm/CS/MainWindow.xaml#L19

<dxdo:DockLayoutManager Grid.Row="2" Name="dockLayoutManager1"  ItemsSource="{Binding ChildViews}">
    <dxdo:DockLayoutManager.LayoutRoot>
        <dxdo:LayoutGroup Caption="LayoutRoot" >

wpf-docklayoutmanager-use-layoutadapter-to-build-dock-ui-with-mvvm/CS/dxSampleGrid/MainWindow.xaml#L27

</dxdo:MVVMHelper.LayoutAdapter>
<dxdo:DockLayoutManager.LayoutRoot>
    <dxdo:LayoutGroup x:Name="LayoutGroup1">