Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

RibbonSelectBoxItemOptions Interface

Declares ribbon select box item settings.

#Declaration

TypeScript
export interface RibbonSelectBoxItemOptions

#Properties

#acceptCustomValue Property

Specifies whether the item accepts custom values.

#Declaration

TypeScript
acceptCustomValue?: boolean

#Property 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

TypeScript
beginGroup?: boolean

#Property 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

TypeScript
displayExpr?: string

#Property 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

TypeScript
onCustomItemCreating?: any

#Property 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

TypeScript
placeholder?: string

#Property Value

Type Description
string

The placeholder text.

#showClearButton Property

Specifies whether to display the Clear button in the item.

#Declaration

TypeScript
showClearButton?: boolean

#Property 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

TypeScript
textOptions?: RibbonItemTextOptions

#Property Value

Type Description
RibbonItemTextOptions

An object that contains text options.

#value Property

Specifies the currently selected value.

#Declaration

TypeScript
value?: any

#Property Value

Type Description
any

The currently selected value.

#valueExpr Property

Specifies the data field that provides values for the editor items.

#Declaration

TypeScript
valueExpr?: string

#Property Value

Type Description
string

The name of the data field.

#valueType Property

#Declaration

TypeScript
valueType?: string

#Property Value

Type
string

#width Property

Specifies the item width.

#Declaration

TypeScript
width?: any

#Property Value

Type Description
any

The item width.