ASPxClientRibbonItem.GetValue Method

Returns the item value.

Declaration

GetValue(): any

Returns

Type	Description
any	An Object that is the item value.

Remarks

Use the GetValue method to access the item value. To specify the value, use the ASPxClientRibbonItem.SetValue method.

The type of value returned by the GetValue method depends on the processed ribbon item type. The table below lists the ribbon items with the returned values.

Editor Name	Server-Side Class	Return Value
Button	RibbonButtonItem	null
Check Box	RibbonCheckBoxItem	true if the item is checked; otherwise false
Color Button	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.
Combo Box	RibbonComboBoxItem	A string representation of the item value
Date Edit	RibbonDateEditItem	A date object specifying the item value
Drop-Down Button	RibbonDropDownButtonItem	null
Drop-Down Toggle Button	RibbonDropDownToggleButtonItem	true if the item is checked; otherwise false
Drop-Down Gallery	RibbonGalleryDropDownItem	Depends on the RibbonGalleryProperties.ValueType property
Gallery Bar	RibbonGalleryBarItem	Depends on the RibbonGalleryBarItem.ValueType property
Option Button	RibbonOptionButtonItem	true if the item is checked; otherwise false
Spin Edit	RibbonSpinEditItem	A number specifying the item value
Template Item	RibbonTemplateItem	null
Text Box	RibbonTextBoxItem	A string representation of the item value
Toggle Button	RibbonToggleButtonItem	true if the item is checked; otherwise false