Tab

ASPxDockManager.BeforeDock Event

Fires on the server side before a panel is docked in a zone and allows you to cancel the action.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v20.2.dll

Declaration

public event DockManagerCancelEventHandler BeforeDock

Event Data

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

Property Description
Cancel Gets or sets a value indicating whether the action that raised the event should be canceled.
Panel Gets the panel currently being processed. Inherited from DockManagerEventArgs.
Zone Gets the zone currently being processed. Inherited from DockManagerEventArgs.

Remarks

Write a BeforeDock event handler to perform specific actions on the server side before every time the panel is docked. You can use the event parameter's properties to identify a panel (DockManagerEventArgs.Panel) and zone (DockManagerEventArgs.Zone) currently being processed.

Note that if the Cancel property is set to true in the event's handler, the execution of the current command is canceled, and therefore no further processing is performed (that is, the panel is not docked).

NOTE

The BeforeDock event only fires when you dock a panel by dragging it. If you dock a panel programmatically (e.g. by setting the ASPxDockPanel.OwnerZoneUID property) it does not result in firing the event.

To learn more, see the Common Docking Events topic.

See Also