ASPxClientRibbonItem.SetValue(value) Method
Sets the item value.
#Declaration
SetValue(
value: any
): void
#Parameters
Name | Type | Description |
---|---|---|
value | any | An that specifies the item value. |
#Remarks
Use the SetValue method to specify the item value. To get the value, use the ASPxClientRibbonItem.GetValue method.
The format of the value parameter depends on the processed ribbon item type. The table below lists the ribbon items with the value formats.
Editor Name | Server-Side Class | Value Format | Example |
---|---|---|---|
Button | - | - | |
Check Box |
| ribbon | |
Color Button | The method supports the following color value formats.
| ribbon ribbon ribbon ribbon | |
Combo Box | A string that is the item text value | ribbon | |
Date Edit | A date object specifying the item value | ribbon | |
Drop-Down Button | - | - | |
Drop-Down Toggle Button |
| ribbon | |
Drop-Down Gallery | Depends on the Ribbon | ribbon | |
Gallery Bar | Depends on the Ribbon | ribbon | |
Option Button |
| ribbon | |
Spin Edit | A number specifying the item value | ribbon | |
Template Item | - | - | |
Text Box | A string specifying the item value | ribbon | |
Toggle Button |
| ribbon |