DockLayoutManager.DockItemRestoring Event

Fires before a dock item is restored from the closed (hidden) state, and allows you to prevent this action.

Namespace: DevExpress.Xpf.Docking

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

Declaration

public event DockItemCancelEventHandler DockItemRestoring
Public Event DockItemRestoring As DockItemCancelEventHandler

Event Data

The DockItemRestoring 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.

Remarks

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

Closed (hidden) items can be accessed via the DockLayoutManager.ClosedPanels collection.

See Also