BaseView.FloatingDocumentContainer Property

Gets or sets a type of container for floating documents within the current BaseView.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

[DefaultValue(FloatingDocumentContainer.Default)]
[XtraSerializableProperty]
public virtual FloatingDocumentContainer FloatingDocumentContainer { get; set; }
<DefaultValue(FloatingDocumentContainer.Default)>
<XtraSerializableProperty>
Public Overridable Property FloatingDocumentContainer As FloatingDocumentContainer

Property Value

Type Default Description
FloatingDocumentContainer

Default

A FloatingDocumentContainer enumerator value that specifies the type of container for floating documents within the current BaseView.

Remarks

Floating BaseView's documents can be hosted in two types of containers. If the FloatingDocumentContainer property is set to SingleDocument, every floating document is hosted within its personal container. Such documents can be docked only to a DocumentManager. If the FloatingDocumentContainer property is set to DocumentsHost, floating documents are hosted within a container to which other documents can be docked. Documents docked to such a floating container are presented as tabs. The figure below shows an example:

DocumentManager - Float Document Host

Use the BaseView.AddFloatingDocumentsHost method to display the specified control/form within a floating document container. Note that this method has no effect if the FloatingDocumentContainer property is not set to the DocumentsHost value.

A floating document container contains its own DocumentManager. Thus, all events related to floating documents are fired for this local manager rather than for the main DocumentManager. If you need to handle these events, create your own custom document container that owns the DocumentManager component and subscribe to this manager's required events. See the BaseView.CustomDocumentsHostWindow property for an example.

See Also