ITabbedViewController.Dock(Document, DocumentGroup) Method

Docks the specified document to the specified group.

Namespace : DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

bool Dock(
    Document document,
    DocumentGroup group
)

Function Dock(
    document As Document,
    group As DocumentGroup
) As Boolean

Parameters

Name	Type	Description
document	Document

A Document object to be docked.

| | group | DocumentGroup |

A DocumentGroup object where the document 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 documents within a group via the IDocumentGroupDefaultProperties.MaxDocuments/IDocumentGroupProperties.MaxDocuments properties. If a group is displaying the maximum number of documents ( MaxDocuments ), and you try to dock a new document to this group via the Dock method, the operation will not be successful.