Skip to main content

IDockController.AddDocumentPanel(DocumentGroup, Uri) Method

Adds a new DocumentPanel to the specified DocumentGroup and loads the contents of a Window, Page or UserControl defined in the specified XAML into the DocumentPanel.

Namespace: DevExpress.Xpf.Docking

Assembly: DevExpress.Xpf.Docking.v21.2.dll

Declaration

DocumentPanel AddDocumentPanel(
    DocumentGroup group,
    Uri uri
)

Parameters

Name Type Description
group DocumentGroup

A DocumentGroup object to which a new DocumentPanel is added.

uri Uri

The uniform resource identifier (URI) of the XAML that defines a Window, Page or UserControl to be loaded into the created DocumentPanel.

Returns

Type Description
DocumentPanel

The created DocumentPanel object.

Remarks

When the URI refers to a Window or Page, the AddDocumentPanel method loads the contents of the specified Window/Page. The Window/Page objects themselves, and their resources and event handlers are not loaded, and they will not be available from the inherited LayoutPanel.Control property.

When the URI refers to a UserControl, the UserControl itself is loaded. Use the inherited LayoutPanel.Control property to access the loaded UserControl.

Note

The XAML file load is delegated to the Application.LoadComponent method.

Example

The following code adds a new DocumentPanel object to a DocumentGroup, and loads the content of the “ChildPage.xaml” into this panel:

DocumentPanel panel = dockLayoutManager1.DockController.AddDocumentPanel(
    documentGroup1, new Uri(@"Layouts\ChildPage.xaml", UriKind.Relative));
panel.Caption = "Page 1";

View Example: How To Load An External Window Or UserControl Into a DocumentPanel

See Also