RibbonModel API in JavaScript (ES5) Spreadsheet API control

Interface for a class Ribbon

Properties

beforeClose

EmitType<BeforeOpenCloseMenuEventArgs>

Triggers before closing the file menu.

beforeFileMenuItemRender

EmitType<MenuEventArgs>

Triggers while rendering each file menu item.

beforeOpen

EmitType<BeforeOpenCloseMenuEventArgs>

Triggers before opening the file menu.

clicked

EmitType<ClickEventArgs>

Triggers while clicking the ribbon content elements.

created

EmitType<Event>

Triggers once the component rendering is completed.

expandCollapse

EmitType<ExpandCollapseEventArgs>

Triggers once the component rendering is completed.

fileMenuItemSelect

EmitType<MenuEventArgs>

Triggers while selecting the file menu item.

selecting

EmitType<SelectingEventArgs>

Triggers while selecting the tab item.

cssClass

string

Defines class/multiple classes separated by a space in the Spreadsheet element.

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

enableRtl

boolean

Enable or disable rendering component in right to left direction.

items

RibbonItemModel[]

An array of object that is used to configure the Ribbon tab.

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

menuItems

MenuItemModel[]

An array of object that is used to configure the Ribbon menu.

menuType

boolean

Used the specify the ribbon menu type as Menu or Sidebar.

selectedTab

number

Specifies the index for activating the current Ribbon tab.