RibbonItemModel API in JavaScript Ribbon API control

Interface for a class RibbonItem

Properties

activeSize

RibbonItemSize

Defines the active size of the ribbon item.

allowedSizes

RibbonItemSize

Defines the sizes that are allowed for the ribbon item on ribbon resize.

buttonSettings

RibbonButtonSettingsModel

Defines the settings for the ribbon button.

checkBoxSettings

RibbonCheckBoxSettingsModel

Defines the settings for the ribbon checkbox.

colorPickerSettings

RibbonColorPickerSettingsModel

Defines the settings for the ribbon color picker.

comboBoxSettings

RibbonComboBoxSettingsModel

Defines the settings for the ribbon combobox.

cssClass

string

Defines one or more CSS classes to customize the appearance of item.

disabled

boolean

Defines whether the item is disabled or not.

displayOptions

DisplayMode

Defines the display options for the ribbon item.

dropDownSettings

RibbonDropDownSettingsModel

Defines the settings for the ribbon dropdown button.

gallerySettings

RibbonGallerySettingsModel

Defines the properties of the gallery view in Ribbon.

groupButtonSettings

RibbonGroupButtonSettingsModel

Defines the properties for group button in Ribbon

id

string

Defines a unique identifier for the item.

itemTemplate

string | HTMLElement | Function

Defines the template content for the ribbon item. ActiveSize property is passed as string in template context.

keyTip

string

Defines the key tip text to be accessed for specified Ribbon item.

ribbonTooltipSettings

RibbonTooltipModel

Defines the settings for the tooltip of the item.

splitButtonSettings

RibbonSplitButtonSettingsModel

Defines the settings for the ribbon split button.

type

RibbonItemType | string

Defines the type of control to be added as the Ribbon Item.