ASPxClientRibbonCommandExecutedEventArgs.parameter Property

Gets an optional parameter that complements the processed command.

Declaration

parameter: string

Property Value

Type Description
string

A string value containing additional information about the processed command.

Remarks

The parameter property complements the ASPxClientRibbonCommandExecutedEventArgs.item property, allowing you to obtain additional information about the command being processed.

The table below contains descriptions of values returned by the parameter property upon the processed item type.

Item Type

Return Value

RibbonButtonItem

null

RibbonCheckBoxItem

true if the item has been checked; otherwise false

RibbonColorButtonItem

16-bit RGB hexadecimal representation of a color in a string format, e.g., #ff0000

Or the RibbonColorButtonItem.AutomaticColorItemValue property value, if the automatic color item is selected.

RibbonComboBoxItem

A string representation of the item value

RibbonDateEditItem

A string representation of the item value

RibbonDropDownButtonItem

null

RibbonDropDownToggleButtonItem

true if the item has been checked; otherwise false

RibbonGalleryBarItem

Depends on the RibbonGalleryBarItem.ValueType property

RibbonGalleryDropDownItem

Depends on the RibbonGalleryProperties.ValueType property

RibbonOptionButtonItem

true if the item has been checked; otherwise false

RibbonSpinEditItem

A string representation of the item value

RibbonTemplateItem

-

RibbonTextBoxItem

A string representation of the item value

RibbonToggleButtonItem

true if the item has been checked; otherwise false

See Also