DockManager.StartDocking Event

Fires when a docking operation starts.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

[DXCategory("Docking")]
public event DockPanelCancelEventHandler StartDocking
<DXCategory("Docking")>
Public Event StartDocking As DockPanelCancelEventHandler

Event Data

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

Property Description
Cancel Gets or sets whether the operation performed on the processed panel should be cancelled.
Panel Gets the processed dock panel. Inherited from DockPanelEventArgs.

Remarks

End-users can perform docking operations by pressing the dock panel's caption with the mouse and dragging it. Once the dragging operation starts, the StartDocking event fires. Handle this event to prevent end-users from performing docking operations on panel(s).

The event parameter's DockPanelCancelEventArgs.Cancel property specifies whether the docking operation is allowed. The processed dock panel is identified by the DockPanelEventArgs.Panel property.

For more information and examples on how docking operations can be performed in code, see the Controlling Dock Operations document.

See Also