DockLayoutManager.LayoutItemActivating Event

Fires when a layout item is about to be activated.

Namespace: DevExpress.Xpf.Docking

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

NuGet Package: DevExpress.Wpf.Docking

Declaration

C#

public event LayoutItemCancelEventHandler LayoutItemActivating

VB.NET

Public Event LayoutItemActivating As LayoutItemCancelEventHandler

Event Data

The LayoutItemActivating 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

An end-user can activate a layout item by clicking it. When an item is activated by clicking, focus is moved to the layout item’s control.

An item can also be activated via the LayoutController.Activate method of the DockLayoutManager.LayoutController object. This method allows you to choose whether to move focus to the control associated with the layout item.

To prevent a layout item from being activated, do one of the following:

• Set the BaseLayoutItem.AllowActivate option to false.
• Handle the LayoutItemActivating event and set the event’s Cancel parameter to true.

The LayoutItemActivating is a notification event that fires after a layout item has been activated.