BaseView.AddFloatingDocumentsHost(Control) Method

Creates a documents host window that contains a newly created document wrapping the specified control. This method is in effect in the DocumentsHost mode.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public bool AddFloatingDocumentsHost(
    Control control
)

VB.NET

Public Function AddFloatingDocumentsHost(
    control As Control
) As Boolean

Parameters

Name	Type	Description
control	Control	A Control that should be wrapped by the newly created document residing in the created documents host window.

Returns

Type	Description
Boolean	true if a documents host window is successfully created; otherwise, false.

Remarks

This method is in effect if the BaseView.FloatingDocumentContainer property is set to DocumentsHost.

The AddFloatingDocumentsHost method creates the BaseDocument object that wraps the specified control. This document resides in the newly created documents host window.

To create a single floating document which does not reside in a documents host window, use the AddFloatDocument method.