ITabbedViewController.Dock(DockPanel, DocumentGroup, Int32) Method

Docks the specified DockPanel to the specified group at a specific position, 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,
    int insertIndex
)

VB.NET

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

Parameters

Name	Type	Description
dockPanel	DockPanel	A DockPanel object to be docked.
group	DocumentGroup	A DocumentGroup object where the panel should be docked.
insertIndex	Int32	An integer value that specifies the index at which the panel will be docked. The visual order of documents and panels within a group is specified by the DocumentGroup.Items property.

Returns

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

Remarks

You can limit the number of items (documents and dock panels) displayed simultaneously 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.