RibbonSelectBoxItemOptions Interface
Declares ribbon select box item settings.
Declaration
export interface RibbonSelectBoxItemOptionsProperties
acceptCustomValue Property
Specifies whether the item accepts custom values.
Declaration
acceptCustomValue?: booleanProperty Value
| Type | Description |
|---|---|
| boolean | true to accept custom values; otherwise, false. |
Remarks
Set the acceptCustomValue property to true to allow a user to add new values to the select box. Note that in this case, you should implement the onCustomItemCreating handler to create a new data source entry.
beginGroup Property
Specifies whether an item separator should be displayed before the current item.
Declaration
beginGroup?: booleanProperty Value
| Type | Description |
|---|---|
| boolean | true to display a separator before the item; otherwise, false. |
displayExpr Property
Specifies the data field whose values should be displayed.
Declaration
displayExpr?: stringProperty Value
| Type | Description |
|---|---|
| string | The name of the data field. |
onCustomItemCreating Property
Specifies a function that is executed when a user adds a custom item.
Declaration
onCustomItemCreating?: anyProperty Value
| Type | Description |
|---|---|
| any | A function that creates a new data source entry. |
Remarks
When the acceptCustomValue property is set to true, a user is allowed to add new values to the select box. Write the onCustomItemCreating function code to create a new data source entry.
placeholder Property
Specifies the text displayed by the item when its value is empty.
Declaration
placeholder?: stringProperty Value
| Type | Description |
|---|---|
| string | The placeholder text. |
showClearButton Property
Specifies whether to display the Clear button in the item.
Declaration
showClearButton?: booleanProperty Value
| Type | Description |
|---|---|
| boolean | true to display the Clear button; otherwise, false. |
textOptions Property
Specifies options of the text displayed next to the item.
Declaration
textOptions?: RibbonItemTextOptionsProperty Value
| Type | Description |
|---|---|
| RibbonItemTextOptions | An object that contains text options. |
value Property
Specifies the currently selected value.
Declaration
value?: anyProperty Value
| Type | Description |
|---|---|
| any | The currently selected value. |
valueExpr Property
Specifies the data field that provides values for the editor items.
Declaration
valueExpr?: stringProperty Value
| Type | Description |
|---|---|
| string | The name of the data field. |
width Property
Specifies the item width.
Declaration
width?: anyProperty Value
| Type | Description |
|---|---|
| any | The item width. |