DockingOptions.AllowRestoreToAutoHideContainer Property

Gets or sets whether or not dock panels that have been dragged away from their parent auto-hide containers should return to these containers when docked again.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v20.2.dll

Declaration

[DefaultValue(false)]
[XtraSerializableProperty]
public virtual bool AllowRestoreToAutoHideContainer { get; set; }
<DefaultValue(False)>
<XtraSerializableProperty>
Public Overridable Property AllowRestoreToAutoHideContainer As Boolean

Property Value

Type Default Description
Boolean

false

true if dock panels should return to their former auto-hide containers when docked; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library Object Type Path to AllowRestoreToAutoHideContainer
WinForms Controls SnapDockManager
.DockingOptions.AllowRestoreToAutoHideContainer
DockManager
.DockingOptions.AllowRestoreToAutoHideContainer
Reporting XRDesignDockManager
.DockingOptions.AllowRestoreToAutoHideContainer

Remarks

When a user drags a dock panel away from an auto-hide container and leaves it floating, they can then right-click this panel's header and select "Dock". By default, this will dock a panel next to its former parent container, but the panel will remain visible. The figure below illustrates this default behavior.

DockManager - Dock To AutoHide

If the AllowRestoreToAutoHideContainer property is enabled, after a end-user clicks "Dock" the panel will return to its original location inside the auto-hide container.

See Also