RibbonItem API in JavaScript (ES5) Ribbon API control

Defines the ribbon item.

Properties

activeSize

RibbonItemSize

Defines the active size of the ribbon item.

Defaults to ‘Medium’

allowedSizes

RibbonItemSize

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

Defaults to null

buttonSettings

RibbonButtonSettingsModel

Defines the settings for the ribbon button.

Defaults to {}

checkBoxSettings

RibbonCheckBoxSettingsModel

Defines the settings for the ribbon checkbox.

Defaults to {}

colorPickerSettings

RibbonColorPickerSettingsModel

Defines the settings for the ribbon color picker.

Defaults to {}

comboBoxSettings

RibbonComboBoxSettingsModel

Defines the settings for the ribbon combobox.

Defaults to {}

cssClass

string

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

Defaults to ”

disabled

boolean

Defines whether the item is disabled or not.

Defaults to false

displayOptions

DisplayMode

Defines the display options for the ribbon item.

Defaults to ‘Auto’

dropDownSettings

RibbonDropDownSettingsModel

Defines the settings for the ribbon dropdown button.

Defaults to {}

gallerySettings

RibbonGallerySettingsModel

Defines the properties of the gallery view in Ribbon.

Defaults to {}

groupButtonSettings

RibbonGroupButtonSettingsModel

Defines the properties for group button in Ribbon

Defaults to {}

id

string

Defines a unique identifier for the item.

Defaults to ”

itemTemplate

string | HTMLElement | Function

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

Defaults to ”

keyTip

string

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

Defaults to ”

ribbonTooltipSettings

RibbonTooltipModel

Defines the settings for the tooltip of the item.

Defaults to {}

splitButtonSettings

RibbonSplitButtonSettingsModel

Defines the settings for the ribbon split button.

Defaults to {}

type

RibbonItemType | string

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

Defaults to RibbonItemType.Button