Ribbon
12 Sep 20255 minutes to read
Ribbon class for DocumentEditorContainer
Methods
addGroup
Adds a new group to an existing tab in the ribbon.
| Parameter | Type | Description |
|---|---|---|
| tabId |
string | RibbonTabType
|
The ID or type of the tab to add the group to. |
| group | RibbonGroupModel |
The ribbon group model to add. |
| insertBefore (optional) | number |
Specifies the existing group index before which the new group will be inserted. If not specified, the new group will be inserted at the end. |
Returns void
addItem
Adds a new item to an existing group in the ribbon.
| Parameter | Type | Description |
|---|---|---|
| groupId | RibbonGroupInfo |
The information about the group to add the item to. |
| item | RibbonItemModel |
The ribbon item model to add. |
| insertBefore (optional) |
string | number
|
Specifies the existing item ID or index before which the new item will be inserted. If a string is provided, it’s treated as an item ID. If a number is provided, it’s treated as an item index. If not specified, the new item will be inserted at the end of the group. |
Returns void
addTab
Adds a new tab to the ribbon UI.
| Parameter | Type | Description |
|---|---|---|
| tab | RibbonTabModel |
The ribbon tab model to add. |
| insertBefore (optional) |
string | RibbonTabType
|
Specifies the existing tab ID or type before which the new tab will be inserted. If not specified, the new tab will be inserted at the end of the ribbon. |
Returns void
enableItems
Enables or disables specific items in the ribbon.
| Parameter | Type | Description |
|---|---|---|
| itemId |
string | RibbonItemInfo
|
The ID of the item or item information object to show or hide. If a string is provided, it’s treated as an item ID. If a RibbonItemInfo object is provided, it will enable/disable items based on the specified tab, group, and item indexes. |
| enable | boolean |
Whether to enable (true) or disable (false) the items. |
Returns void
showGroup
Shows or hides a specific group in a tab.
| Parameter | Type | Description |
|---|---|---|
| groupId |
string | RibbonGroupInfo
|
The ID of the group or group info to show or hide. |
| show | boolean |
Whether to show (true) or hide (false) the group. |
Returns void
showItems
Shows or hides specific items in the ribbon.
| Parameter | Type | Description |
|---|---|---|
| itemId |
string | RibbonItemInfo
|
The ID of the item or item information object to show or hide. If a string is provided, it’s treated as an item ID. If a RibbonItemInfo object is provided, it will show/hide items based on the specified tab, group, and item indexes. |
| show | boolean |
Whether to show (true) or hide (false) the item(s). |
Returns void
showTab
Shows or hides a specific tab in the ribbon.
| Parameter | Type | Description |
|---|---|---|
| tabId |
string | RibbonTabType
|
The ID or type of the tab to show or hide. |
| show | boolean |
Whether to show (true) or hide (false) the tab. |
Returns void