Skip to main content

DockLayoutManager.DockItemEndDocking Event

Fires after a dock item has been dropped, and allows you to prevent this action.

Namespace: DevExpress.Xpf.Docking

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

NuGet Package: DevExpress.Wpf.Docking

Declaration

public event DockItemDockingEventHandler DockItemEndDocking

Event Data

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

Property Description
Cancel Gets or sets whether the current operation must be canceled. Inherited from ItemCancelEventArgs.
DockTarget Gets the item to which the current item is being docked.
DockType Gets how an item is being docked to another item.
DragPoint Gets the point at which the item is being docked. The point is relative to the top left corner of the target item’s root parent.
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.
IsHiding Gets whether the item is being docked over a zone used to set the item to the auto-hide state.
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 panel from being docked where it’s dropped, set the Cancel parameter to true.

You can also set an item’s BaseLayoutItem.AllowDock property to false to prevent the item from being docked.

See Also