ASPxClientDockManager.BeforeFloat Event

Fires on the client side before a panel is made floating (undocked from a zone) and allows you to cancel the action.

Declaration

BeforeFloat: ASPxClientEvent<ASPxClientDockManagerProcessingModeCancelEventHandler<ASPxClientDockManager>>

Event Data

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

Property	Description
cancel	Gets or sets a value indicating whether the action which raised the event should be canceled. Inherited from ASPxClientProcessingModeCancelEventArgs.
panel	Gets the panel currently being processed.
processOnServer	Specifies whether or not to process the event on the server. Inherited from ASPxClientProcessingModeEventArgs.
zone	Gets the zone currently being processed.

Remarks

Write a BeforeFloat event handler to perform specific actions on the client side before each time the panel is made floating. You can use the event parameter’s properties to identify a panel (ASPxClientDockManagerCancelEventArgs.panel) and a zone (ASPxClientDockManagerProcessingModeCancelEventArgs.zone) from which the panel is undocked.

Note

If a panel is dragged and dropped directly from one zone to another, the BeforeFloat event is not raised, because the panel does not change its state to float.

Note that if the cancel property is set to true in the event’s handler, the execution of the current command is canceled on the client side, and therefore no further processing is performed (that is the panel is not floated). If the command execution is not canceled (the cancel property is set to the default false value), further event processing depends upon the processOnServer property setting.

If the processOnServer property is set to false, the BeforeFloat event is completely handled on the client side, using the assigned JScript handler without a postback to the server.

Setting the processOnServer property to true indicates that the final processing of the event should be performed on the server side, and so a round trip to the server is required. During such a round trip, the corresponding server-side ASPxDockManager.BeforeFloat event is fired, which when handled, allows any desired server-side action to be performed.

To learn more, see the Common Docking Events topic.