ITabbedViewController.Dock(DockPanel, DocumentGroup) Method

Docks the specified DockPanel to the specified group, displaying the panel as a tab.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

bool Dock(
    DockPanel dockPanel,
    DocumentGroup group
)

VB.NET

Function Dock(
    dockPanel As DockPanel,
    group As DocumentGroup
) As Boolean

Parameters

Name	Type	Description
dockPanel	DockPanel	A DockPanel object to be docked.
group	DocumentGroup	A DocumentGroup object where the dock panel should be docked.

Returns

Type	Description
Boolean	true if the operation was a success; otherwise, false.

Remarks

You can limit the number of simultaneously displayed items (documents and dock panels) within a group via the IDocumentGroupDefaultProperties.MaxDocuments/IDocumentGroupProperties.MaxDocuments properties. If a group is displaying the maximum number of items (MaxDocuments), and you try to dock a new item to this group via the Dock method, the operation will not be successful.