Common Docking Events

  • 2 min to read

All controls included in the ASPxDocking Suite (such as ASPxDockPanel, ASPxDockZone and ASPxDockManager) provide advanced client-side and server-side event support. These controls give you the ability to completely control the behavior of dock panels and zones.

The most typical end-user actions (such as dragging and docking) invoke common events of all the 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, allowing 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, allowing you to cancel the action if required.

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

Event Dock Manager Events Dock Zone Events Dock Panel Events
StartDragging (client) ASPxClientDockManager.StartPanelDragging - ASPxClientDockPanel.StartDragging
EndDragging (client) ASPxClientDockManager.EndPanelDragging - ASPxClientDockPanel.EndDragging
BeforeDock (server/client) ASPxDockManager.BeforeDock / ASPxClientDockManager.BeforeDock ASPxDockZone.BeforeDock / ASPxClientDockZone.BeforeDock ASPxDockPanel.BeforeDock / ASPxClientDockPanel.BeforeDock
AfterDock (server/client) ASPxDockManager.AfterDock / ASPxClientDockManager.AfterDock ASPxDockZone.AfterDock / ASPxClientDockZone.AfterDock ASPxDockPanel.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.

Docking_BeforeAfterDock

See Also