BaseView.AddFloatingDocumentsHost(BaseDocument[]) Method

Creates a floating documents host (container) that will contain the specific BaseDocument objects collection.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

public bool AddFloatingDocumentsHost(
    BaseDocument[] documents
)

VB.NET

Public Function AddFloatingDocumentsHost(
    documents As BaseDocument()
) As Boolean

Parameters

Name	Type	Description
documents	BaseDocument[]	A BaseDocument objects collection that stores Documents hosted within the newly created floating documents container.

Returns

Type	Description
Boolean	true, if a floating documents host was successfully added; otherwise, false.

Remarks

See the BaseView.FloatingDocumentContainer property to learn more. If this property is not set to DocumentsHost, calling the AddFloatingDocumentsHost method will have no effect.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AddFloatingDocumentsHost(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-save-and-restore-layouts-of-floating-documents-residing-within-documentshost-t146388/CS/DXApplication2/Main.cs#L89

    BaseDocument[] documents = tabbedView1.Documents.Where(doc => controlNames.Contains(doc.ControlName)).ToArray();
    tabbedView1.AddFloatingDocumentsHost(documents);
}

VB.NET

how-to-save-and-restore-layouts-of-floating-documents-residing-within-documentshost-t146388/VB/DXApplication2/Main.vb#L85

    Dim documents() As BaseDocument = tabbedView1.Documents.Where(Function(doc) controlNames.Contains(doc.ControlName)).ToArray()
    tabbedView1.AddFloatingDocumentsHost(documents)
Next host