Back to Devexpress

Common Docking Events

aspnet-9725-components-docking-and-popups-docking-common-docking-events.md

latest3.9 KB
Original Source

Common Docking Events

  • Jun 24, 2021
  • 2 minutes to read

All controls included in the ASPxDocking Suite (such as ASPxDockPanel, ASPxDockZone and ASPxDockManager) contain advanced client-side and server-side events. These controls allow you to control the behavior of dock panels and zones.

Typical end-user actions (such as drag and dock actions) invoke common events for all key elements of the panel docking functionality.

  • StartDragging and EndDragging events, specific to ASPxDockPanel ( StartPanelDragging and EndPanelDragging specific to ASPxDockManager), allow you to respond to the corresponding end-user actions performed on a panel.
  • BeforeDock and AfterDock events are common for ASPxDockPanel, ASPxDockZone and ASPxDockManager. They fire before and after a panel is docked to a zone, which allows you to cancel panel docking if required.
  • BeforeFloat and AfterFloat events are common for ASPxDockPanel and ASPxDockManager. They fire before and after a panel is undocked from a zone, which allows you to cancel the action if required.

The table below lists available client-side and server-side common docking events.

EventDock Manager EventsDock Zone EventsDock Panel Events
StartDragging (client)ASPxClientDockManager.StartPanelDragging-ASPxClientDockPanel.StartDragging
EndDragging (client)ASPxClientDockManager.EndPanelDragging-ASPxClientDockPanel.EndDragging
BeforeDock (server/client)ASPxDockManager.BeforeDock / ASPxClientDockManager.BeforeDockASPxDockZone.BeforeDock / ASPxClientDockZone.BeforeDockASPxDockPanel.BeforeDock / ASPxClientDockPanel.BeforeDock
AfterDock (server/client)ASPxDockManager.AfterDock / ASPxClientDockManager.AfterDockASPxDockZone.AfterDock / ASPxClientDockZone.AfterDockASPxDockPanel.AfterDock / ASPxClientDockPanel.AfterDock
BeforeFloat (server/client)ASPxDockManager.BeforeFloat / ASPxClientDockManager.BeforeFloat-ASPxDockPanel.BeforeFloat / ASPxClientDockPanel.BeforeFloat
AfterFloat (server/client)ASPxDockManager.AfterFloat / ASPxClientDockManager.AfterFloat-ASPxDockPanel.AfterFloat / ASPxClientDockPanel.AfterFloat

The image below demonstrates a sequence of events invoked when an end-user drags and docks a panel.

See Also

Online Demo: Docking - Client-Side Events

Online Demo: Docking - Server-Side Functionality