The requested page is not available for the requested platform. You are viewing the content for Default platform.

ASPxClientRibbon.CommandExecuted Event

Occurs after an end-user executes an action on a ribbon item.

Declaration

CommandExecuted: ASPxClientEvent<ASPxClientRibbonCommandExecutedEventHandler<ASPxClientRibbon>>

Event Data

The CommandExecuted event handler receives an argument of the ASPxClientRibbonCommandExecutedEventArgs type. The following properties provide information specific to this event.

Property Description
item Gets an item object related to the event.
parameter Gets an optional parameter that complements the processed command.
processOnServer Gets or sets a value that specifies whether the event should be finally processed on the server side.

Remarks

Handle the CommandExecuted event to perform specific client actions after an end-user executes an action on a ribbon item (e.g., clicks a button, changes an editor value).

The processed item is returned by the ASPxClientRibbonCommandExecutedEventArgs.item property. You can get an additional information about the command being processed using the ASPxClientRibbonCommandExecutedEventArgs.parameter optional parameter.

If the ASPxClientProcessingModeEventArgs.processOnServer property is set to false (default value), the CommandExecuted event is completely handled on the client side using the assigned JScript handler without a postback to the server. Setting the CommandExecuted 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 ASPxRibbon.CommandExecuted event fires which when handled, allows any desired server-side action to be performed.

See Also