RibbonMenuItem Class

A ribbon menu item.

Declaration

export class RibbonMenuItem 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
RibbonMenuItem
See Also

constructor(id, text, items)

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

Declaration

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

Parameters

Name Type Description
id RibbonItemId

The item identifier.

text string

The item text.

items RibbonSubMenuItem[]

An array of sub-items.

options RibbonMenuItemOptions

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

showText Property

Specifies the item's text visibility.

Declaration

showText: boolean

Property Value

Type Description
boolean

true to display the item text; otherwise, false.

Remarks

Use the text property to specify the item text.

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 Menu item type.