IBaseViewController.Float(BaseDocument) Method

Makes the specified document floating.

Namespace : DevExpress.XtraBars.Docking2010.Views

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

bool Float(
    BaseDocument document
)

Function Float(
    document As BaseDocument
) As Boolean

Parameters

Name	Type	Description
document	BaseDocument

A BaseDocument to be made floating.

Returns

Type	Description
Boolean

true if the specified document was made floating; otherwise, false.

Remarks

The Float method makes a document floating. To dock a document back to a container, use the IBaseViewController.Dock method.

The IBaseDocumentDefaultProperties.AllowFloat/IBaseDocumentProperties.AllowFloat properties allow you to prevent a document from being made floating. The IBaseDocumentDefaultProperties.AllowDock/IBaseDocumentProperties.AllowDock properties allow you to prevent a document from being docked.

To access all floating documents use the BaseView.FloatDocuments collection. Docked documents can be accessed via the BaseView.Documents collection.

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.