RibbonButtonItemOptions Interface

Declares ribbon button item settings.

Declaration

export interface RibbonButtonItemOptions

Properties

beginGroup Property

Specifies whether an item separator should be displayed before the current item.

Declaration

beginGroup?: boolean

Property Value

Type	Description
boolean	true to display a separator before the item; otherwise, false.

icon Property

Specifies the item icon’s identifier.

Declaration

icon?: string

Property Value

Type	Description
string	An icon identifier.

Remarks

Refer to the following help topic to view the full list of available icons and their identifiers: Built-In Icon Library.

localizationId Property

Specifies an identifier that allows you to localize the item’s text.

Declaration

localizationId?: string

Property Value

Type	Description
string	The item’s localization identifier.

Remarks

If the text property is specified, the item is not localized.

selected Property

Specifies whether the button is selected.

Declaration

selected?: boolean

Property Value

Type	Description
boolean	true to select the button; otherwise, false.

showText Property

Specifies the item’s text visibility.

Declaration

showText?: boolean

Property Value

Type	Description
boolean	true to display the item's text; otherwise, false.

toggleMode Property

Specifies whether the button is in toggle mode.

Declaration

toggleMode?: boolean

Property Value

Type	Description
boolean	true to enable toggle mode; otherwise, false.