IBaseViewController.Dock(BaseDocument) Method

Docks the specified document to a View.

Namespace : DevExpress.XtraBars.Docking2010.Views

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

bool Dock(
    BaseDocument document
)

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.