Back to Devexpress

ASPxDockZone.BeforeDock Event

aspnet-devexpress-dot-web-dot-aspxdockzone.md

latest2.8 KB
Original Source

ASPxDockZone.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.v25.2.dll

NuGet Package : DevExpress.Web

Declaration

csharp
public event DockZoneCancelEventHandler BeforeDock
vb
Public Event BeforeDock As DockZoneCancelEventHandler

Event Data

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

PropertyDescription
CancelGets or sets a value indicating whether the action that raised the event should be canceled.
PanelGets the panel currently being processed. Inherited from DockZoneEventArgs.

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 property to identify a panel (DockZoneEventArgs.Panel) 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 fires when you dock a panel by dragging it only. If you dock a panel programmatically (e.g. by setting the ASPxDockPanel.OwnerZoneUID property) it does not result firing the event.

To learn more, see the Common Docking Events topic.

See Also

ASPxDockZone.BeforeDock

js-ASPxClientDockZone.BeforeDock

AfterDock

Common Docking Events

Docking

Online Demo: Docking - Server-Side Functionality

ASPxDockZone Class

ASPxDockZone Members

DevExpress.Web Namespace