DockLayoutManager.DockItemActivating Event

Fires before a dock item is activated, and allows you to prevent this action.

Namespace: DevExpress.Xpf.Docking

Assembly: DevExpress.Xpf.Docking.v14.2.dll

Declaration

C#

public event DockItemCancelEventHandler DockItemActivating

VB.NET

Public Event DockItemActivating As DockItemCancelEventHandler

Event Data

The DockItemActivating event's handler receives an argument of the ItemCancelEventArgs type. 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

The DockItemActivating event fires when a new dock item is about to be activated. To cancel this operation, set the event's ItemCancelEventArgs.Cancel parameter to true.

The currently active item can be accessed via the DockLayoutManager.ActiveDockItem property. If the BaseLayoutItem.AllowActivate option is disabled, the item cannot be activated.

After an item has been activated, the DockLayoutManager.DockItemActivated event fires.