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.v24.2.dll
NuGet Package: DevExpress.Wpf.Docking
Declaration
Event Data
The DockItemActivating 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
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.