IBaseViewController.Dock(BaseDocument) Method

Docks the specified document to a View.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

bool Dock(
    BaseDocument document
)

VB.NET

Function Dock(
    document As BaseDocument
) As Boolean

Parameters

Name	Type	Description
document	BaseDocument	A BaseDocument object to be docked to a View.

Returns

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

Remarks

The Dock method docks a document, while the IBaseViewController.Float method makes it floating.

By default, documents within a NativeMdiView can be dragged only within the View’s bounds. These documents are considered “docked”. When you make a document floating within a NativeMdiView, it can be dragged outside the View. To “dock” a document back to a NativeMdiView, so it can be dragged only within the View’s bounds, call the IBaseViewController.Dock method.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Dock(BaseDocument) 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-merge-bars-within-the-documentmanager-control-e4950/CS/DocumentManagerBarMerging/Form1.cs#L29

private void barButtonItem2_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
    if (tabbedView1.ActiveFloatDocument != null) tabbedView1.Controller.Dock(tabbedView1.ActiveFloatDocument);
}

VB.NET

how-to-merge-bars-within-the-documentmanager-control-e4950/VB/DocumentManagerBarMerging/Form1.vb#L33

If tabbedView1.ActiveFloatDocument IsNot Nothing Then
    tabbedView1.Controller.Dock(tabbedView1.ActiveFloatDocument)
End If