ITabbedViewController.Dock(Document, DocumentGroup) Method

Docks the specified document to the specified group.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v19.2.dll

Declaration

C#

bool Dock(
    Document document,
    DocumentGroup group
)

VB.NET

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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Dock(Document, DocumentGroup) 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#

tabbedview-how-to-convert-the-default-layout-to-a-table-one-t323423/CS/FreeLayoutModeExample/ExampleHelper.cs#L46

    foreach (Document doc in tabbedView.Documents)
        tabbedView.Controller.Dock(doc, tempGroup);
}

VB.NET

tabbedview-how-to-convert-the-default-layout-to-a-table-one-t323423/VB/FreeLayoutModeExample/ExampleHelper.vb#L39

For Each doc As Document In tabbedView.Documents
    tabbedView.Controller.Dock(doc, tempGroup)
Next doc