IDockController.Dock(BaseLayoutItem, BaseLayoutItem, DockType) Method

Docks the first item to the second item with the specified dock type.

Namespace: DevExpress.Xpf.Docking

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

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Docking, DevExpress.Wpf.Navigation

Declaration

C#

bool Dock(
    BaseLayoutItem item,
    BaseLayoutItem target,
    DockType type
)

VB.NET

Function Dock(
    item As BaseLayoutItem,
    target As BaseLayoutItem,
    type As DockType
) As Boolean

Parameters

Name	Type	Description
item	BaseLayoutItem	The item to be docked.
target	BaseLayoutItem	The item to which the first item is docked.
type	DockType	A DockType value that specifies how the first item is docked.

Returns

Type	Description
Boolean	true, if the item has been successfully docked; otherwise, false.

Remarks

The type parameter specifies how the first item is docked to the target item. If the parameter is DockType.None, the item is not docked and the Dock method returns false.

Set the type parameter to DockType.Fill and target to a LayoutPanel or TabbedGroup to combine items into a tab group.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Dock(BaseLayoutItem, BaseLayoutItem, DockType) method.

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#

how-to-customize-an-integrated-reviewing-pane-t510789/CS/ReviewingPaneSimpleExample/MainWindow.xaml.cs#L32

//Dock panel to the right
manager.DockController.Dock(commentPanel, documentPanel, DockType.Right);

VB.NET

how-to-customize-an-integrated-reviewing-pane-t510789/VB/ReviewingPaneSimpleExample/MainWindow.xaml.vb#L30

'Dock panel to the right
manager.DockController.Dock(commentPanel, documentPanel, DockType.Right)