IBaseViewController.Float(BaseDocument) Method

Makes the specified document floating.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

bool Float(
    BaseDocument document
)

VB.NET

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.

Related GitHub Examples

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

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

VB.NET

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

If tabbedView1.ActiveDocument IsNot Nothing Then
    tabbedView1.Controller.Float(tabbedView1.ActiveDocument)
End If