DocumentGroup Class

Represents child panels (DocumentPanel objects) using either a tabbed or MDI UI.

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

Declaration

C#
VB.NET

public class DocumentGroup :
    TabbedGroup

Public Class DocumentGroup
    Inherits TabbedGroup

The following members return DocumentGroup objects:

Remarks

DocumentGroup objects are used within the DockLayoutManager to create a tabbed or MDI interface for your documents. Individual pages in a DocumentGroup are represented by DocumentPanel objects.

DocumentGroup

To switch between the tabbed and MDI styles, use the DocumentGroup.MDIStyle property.

In MDI mode, it’s possible to:

set the location and size of child panels via the DocumentPanel.MDILocation and DocumentPanel.MDISize properties.
maximize, minimize or restore a specific child panel via a corresponding method provided by the DockLayoutManager.MDIController object.
tile child panels vertically or horizontally via the methods provided by the DockLayoutManager.MDIController object.

Note

DocumentGroups cannot be used outside the DockLayoutManager component.

See Document Groups and Panels to learn more.

Example 1

This example shows how to create a DocumentGroup with two tabs, represented by DocumentPanel objects.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-create-a-documentgroup-with-two-tabs-e1670.

Window1.xaml

<dxdo:DocumentGroup x:Name="documentGroup1" ItemHeight="2*" SelectedTabIndex="1">
    <dxdo:DocumentPanel x:Name="document1" Caption="Document 1">
        <RichTextBox />
    </dxdo:DocumentPanel>
    <dxdo:DocumentPanel x:Name="document2" Caption="Document 2">
        <RichTextBox />
    </dxdo:DocumentPanel>
</dxdo:DocumentGroup>

Example 2

In this example, MDI mode is enabled for a DocumentGroup via the MDIStyle property. In this mode, the DocumentGroup’s panels are represented as floating windows.

The following image shows the result:

MDI-mode

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-enable-mdi-mode-for-a-documentgroup-e2190.

MainWindow.xaml

<dxdo:DocumentGroup x:Name="documentGroup1" ItemWidth="2*" MDIStyle="MDI">
    <dxdo:DocumentPanel x:Name="document1" Caption="Document 1" MDISize="200,100" >
        <RichTextBox/>
    </dxdo:DocumentPanel>
    <dxdo:DocumentPanel x:Name="document2" Caption="Document 2" MDISize="200,100" MDILocation="50,120" >
        <RichTextBox/>
    </dxdo:DocumentPanel>
</dxdo:DocumentGroup>

The following code snippets (auto-collected from DevExpress Examples) contain references to the DocumentGroup class.

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.

wpf-dock-layout-manager-use-events-to-dynamically-customize-context-menus/CS/DockManager_MenuCustomization/Window1.xaml#L13

</dxdo:LayoutGroup>
<dxdo:DocumentGroup x:Name="documentGroup1">
    <dxdo:DocumentPanel>

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

<dxdo:LayoutGroup>
    <dxdo:DocumentGroup x:Name="documentGroup1" SelectedTabIndex="1" DestroyOnClosingChildren="False" MDIStyle="MDI">
        <dxdo:DocumentPanel x:Name="docPanel1" Caption="Panel 1" MDISize="300,250"/>

wpf-docklayoutmanager-dock-panels-in-code/CS/DockPanelInCode_Ex/Window1.xaml#L9


<dxdo:DocumentGroup x:Name="documentGroup1">
    <dxdo:DocumentPanel x:Name="paneDocument1" Caption="Document 1">

wpf-dock-layout-manager-pin-unpin-a-layout-panel/CS/CreateAutoHiddenPanels/Window1.xaml#L5

<dxdo:LayoutGroup x:Name="rootGroup" Orientation="Horizontal">
    <dxdo:DocumentGroup x:Name="documentGroup1">
        <dxdo:DocumentPanel x:Name="paneDocument1" Caption="Document 1">

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

<dxdo:LayoutGroup Caption="LayoutRoot" >
    <dxdo:DocumentGroup x:Name="DocumentsGroup"/>
    <dxdo:LayoutGroup x:Name="DockPanels" Orientation="Vertical"/>