A newer version of this page is available. Switch to the current version.

DockLayoutManager.DockItemHiding Event

Fires before a dock item is auto-hidden, and allows you to prevent this action.

Namespace: DevExpress.Xpf.Docking

Assembly: DevExpress.Xpf.Docking.v19.1.dll

Declaration

public event DockItemCancelEventHandler DockItemHiding
Public Event DockItemHiding As DockItemCancelEventHandler

Event Data

The DockItemHiding event's data class is ItemCancelEventArgs. The following properties provide information specific to this event:

Property Description
Cancel Gets or sets whether the current operation must be canceled.
Handled Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
Item Gets the currently processed item. Inherited from ItemEventArgs.
OriginalSource Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

The event data class exposes the following methods:

Method Description
InvokeEventHandler(Delegate, Object) When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object) When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

To prevent a dock item from being auto-hidden, set the event's Cancel parameter to true. An alternative way to disable this functionality is to set the BaseLayoutItem.AllowHide option to false. After an item has been auto-hidden, the DockLayoutManager.DockItemHidden event fires.

Auto-hidden items can be accessed via the DockLayoutManager.AutoHideGroups collection.

See Also