AutoHideGroup Class
A container for auto-hidden dock panels.
Namespace: DevExpress.Xpf.Docking
Assembly: DevExpress.Xpf.Docking.v21.2.dll
NuGet Package: DevExpress.Wpf.Docking
Declaration
Remarks
AutoHideGroup objects allow you to display auto-hidden panels. These panels appear only when you hover over or click the panel’s label.
Create Auto-Hide Groups
An AutoHideGroup object can only be a child of the AutoHideGroups class.
In XAML
<Window ...
xmlns:dxdo="http://schemas.devexpress.com/winfx/2008/xaml/docking">
<dxdo:DockLayoutManager>
<dxdo:DockLayoutManager.AutoHideGroups>
<dxdo:AutoHideGroup DockType="Right">
<dxdo:LayoutPanel Caption="Panel1"/>
</dxdo:AutoHideGroup>
</dxdo:DockLayoutManager.AutoHideGroups>
</dxdo:DockLayoutManager>
</Window>
In Code
Use the IDockController.Hide methods to auto-hide a panel.
Tip
Set a panel’s BaseLayoutItem.AllowHide property to false to disable the panel’s auto-hide mode.
Child Items
AutoHideGroups can contain only LayoutPanel objects.
Customize Auto-Hide Groups
Use the following properties to customize an AutoHideGroup:
| Property | Description |
|---|---|
| AutoHideSpeed | Specifies the duration of the panel’s open/close animation. |
| AutoHideSize | Specifies the panel’s size in auto-hide mode. |
| AutoHideType | Specifies the panel’s position when it is hidden. |
| DockType | Specifies the panel’s position when it is expanded. |
| DockLayoutManager.AutoHideExpandMode | Specifies the way an auto-hidden panel is expanded: onmousedown or onhover. |
| DockLayoutManager.AutoHideMode | Specifies whether the auto-hide group should overlay LayoutGroups or be displayed inline. |
| DockLayoutManager.EnableWin32Compatibility | Specifies whether the auto-hide panel should be displayed over a WindowsFormsHost element. |
| LayoutPanel.AutoHideExpandState | Specifies the panel’s state. |
| SizeToContent | Specifies whether an auto-hide group’s panel should be resized according to its content. |
Runtime Operations
Methods
Use the following DockLayoutManager.DockController object’s methods to control an AutoHideGroup at runtime:
| Method | Description |
|---|---|
| Hide | Enables the auto-hide mode for the item/panel and hides it at a corresponding edge of the DockLayoutManager container. |
| Restore(BaseLayoutItem) | Restores a closed (hidden) panel at its previous dock position. |
Events
Use the following DockLayoutManager‘s events to control an AutoHideGroup at runtime:
| Event | Description |
|---|---|
| DockLayoutManager.DockItemDocking | Fires before a dock item is dragged over dock hints, and allows you to prevent dock zones from being displayed. |
| DockLayoutManager.DockItemEndDocking | Fires after a dock item has been dropped, and allows you to prevent this action. |
| DockLayoutManager.DockItemHidden | Fires after a dock item has been made auto-hidden. |
| DockLayoutManager.DockItemHiding | Fires before a dock item is auto-hidden, and allows you to prevent this action. |
| DockLayoutManager.DockItemRestored | Fires after a dock item has been restored from the closed (hidden) state. |
| DockLayoutManager.DockItemRestoring | Fires before a dock item is restored from the closed (hidden) state, and allows you to prevent this action. |
| DockLayoutManager.DockItemStartDocking | Fires when a docking operation starts, and allows you to prevent this operation. |
User Interactions
A user can click the auto-hide (pin) button to auto-hide the panel.
When a user auto-hides a Tabbed Group (clicks its auto-hide (pin) button), the DockLayoutManager creates a new Auto-Hide Group and moves all the Tabbed Group’s children to this group.
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the AutoHideGroup class.
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.