Skip to main content

DashboardItemMenuExtension Class

A Web Dashboard extension that is a dashboard item menu.

#Declaration

TypeScript
export class DashboardItemMenuExtension extends DisposableObject

#Remarks

When registered, the DashboardItemMenuExtension adds the dashboard item menu.

To get access to the DashboardItemMenuExtension settings, call the control’s findExtension(extensionName) method and pass the extension’s name as a parameter.

JavaScript
var ext = dashboardControl.findExtension('itemMenu');

To remove the extension, call the unregisterExtension(extensionNames) method and pass the extension’s unique name as a parameter:

JavaScript
dashboardControl.unregisterExtension('itemMenu');

You can also call the control’s option method to change the extension options.

#Inherited Members

#Inheritance

DisposableObject
DashboardItemMenuExtension

#constructor(dashboardControl)

Initializes a new instance of the DashboardItemMenuExtension class.

#Declaration

TypeScript
constructor(
    dashboardControl: DevExpress.Dashboard.DashboardControl
)

#Parameters

Name Type Description
dashboardControl DashboardControl

A Web Dashboard control that owns the extension.

#Properties

#name Property

Specifies the unique extension name.

#Declaration

TypeScript
name: string

#Property Value

Type Description
string

The unique extension name. The return value is itemMenu.

#Remarks

Use the itemMenu name in the following cases:

  • Call the DashboardControl.findExtension method and pass the extension name as a parameter to access the extension.
  • Call the control’s option method to change the extension options.

Warning

Do not change the unique name of the extension registered in the Web Dashboard to avoid exceptions.

#Methods

#menuItemClick(menuItemId) Method

Clicks the specified menu item in the dashboard item menu.

#Declaration

TypeScript
menuItemClick(
    menuItemId: string
): void

#Parameters

Name Type Description
menuItemId string

A string value that is the menu item id.

#processKeyEvent(keyEventType, eventArgs) Method

Allows you to process which key was pressed.

#Declaration

TypeScript
processKeyEvent(
    keyEventType: DevExpress.Dashboard.KeyEventType,
    eventArgs: JQueryKeyEventObject
): boolean

#Parameters

Name Type Description
keyEventType KeyEventType

The KeyEventType object that identifies a user interaction with the keyboard.

eventArgs JQueryKeyEventObject

A JQueryKeyEventObject object that identifies a key.

#Returns

Type Description
boolean

true, if a key used to open the dashboard item menu; otherwise, false.

#start Method

Contains code that is executed when you register the dashboard extension.

#Declaration

TypeScript
start(): void

#stop Method

Contains code that is executed when you unregister the dashboard extension.

#Declaration

TypeScript
stop(): void