RibbonSubMenuItem Class

A ribbon sub-menu item.

Declaration

export class RibbonSubMenuItem extends RibbonItemBase

Remarks

var ribbonMenu = new DevExpress.RichEdit.RibbonMenuItem;
ribbonMenu.id = "myMenu";
ribbonMenu.beginGroup = true;
ribbonMenu.icon = "favorites";
ribbonMenu.showText = true;
ribbonMenu.text = "Menu";
ribbonMenu.items = [{icon: "user", text: "item 1"}, 
  {icon: "chevronright", text: "item 2", items: [{icon: "image", text: "item 2.1"}, {icon: "image", text: "item 2.2"}]}];

var options = DevExpress.RichEdit.createOptions();
options.ribbon.getTab(DevExpress.RichEdit.RibbonTabType.Home).insertItem(ribbonMenu,3);
options.events.customCommandExecuted.addHandler(function(s, e) {
  switch (e.commandName) {
    case 'myMenu':
      console.log(e.parameter)
    }
});

Inherited Members

Inheritance

RibbonItemBase
RibbonSubMenuItem
See Also

constructor(id, text)

Initializes a new instance of the RibbonSubMenuItem class with specified settings.

Declaration

constructor(
    id: RibbonItemId,
    text: string,
    items?: RibbonSubMenuItem[],
    options?: RibbonSubMenuItemOptions
)

Parameters

Name Type Description
id RibbonItemId

The item identifier.

text string

The item text.

items RibbonSubMenuItem[]

An array of sub-items.

options RibbonSubMenuItemOptions

The item options.

Properties

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.

items Property

Provides access to an array of the menu's sub-items.

Declaration

items: RibbonSubMenuItem[]

Property Value

Type Description
RibbonSubMenuItem[]

An array of sub-items.

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.

See Also

text Property

Specifies the item text.

Declaration

text: string

Property Value

Type Description
string

The item text.

type Property

Returns the item's type.

Declaration

readonly type: RibbonItemType

Property Value

Type Description
RibbonItemType

Identifies the SubMenu item type.

Methods

convertToButton Method

Converts the sub-menu item to a button.

Declaration

convertToButton(): RibbonButtonItem

Returns

Type Description
RibbonButtonItem

The converted item.

Remarks

A ribbon tab can contain items of first-level types only. Use the convertToButton method to convert the sub-menu item to a button that can be added to a ribbon tab.

richEdit.updateRibbon(function (ribbon) {
    var pageLayoutTab = ribbon.getTab(DevExpress.RichEdit.RibbonTabType.PageLayout);
    var subMenuItem = pageLayoutTab.getItem(DevExpress.RichEdit.PageLayoutTabItemId.InsertPageBreak);
    if (subMenuItem) {
        pageLayoutTab.removeItem(DevExpress.RichEdit.PageLayoutTabItemId.InsertPageBreak);
        var insertTab = ribbon.getTab(DevExpress.RichEdit.RibbonTabType.Insert);
        insertTab.insertItem(subMenuItem.convertToButton(), 0);
    }
});