RibbonCommandExecutedEventArgs.Parameter Property

Gets an optional parameter that complements the processed command.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

public string Parameter { get; }

VB.NET

Public ReadOnly Property Parameter As String

Property Value

Type	Description
String	A string value containing additional information about the processed command.

Remarks

The Parameter property complements the RibbonCommandExecutedEventArgs.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
RibbonComboBoxItem	A string representation of the item value
RibbonDateEditItem	A date object specifying 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 number specifying the item value
RibbonTemplateItem	-
RibbonTextBoxItem	A string representation of the item value
RibbonToggleButtonItem	true if the item has been checked; otherwise false