CartLog In
Dashboard
V 19.1
19.2 (EAP/Beta)
19.1
18.2
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
All docs
Docs HTML JS Control API Reference DevExpress.Dashboard.Designer DashboardItemMenuExtension
The requested page is not available for the requested platform. You are viewing the content for Default platform.

General Information

.NET Subscription

Overview

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Desktop

Controls

WinForms
WPF
VCL
UWP (Windows 10)

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Web

Controls and Extensions

ASP.NET Controls and MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Mainteinance Mode

ASP.NET Core Bootstrap Controls

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
Dashboard
Office File API

Quality Assurance and Productivity

CodeRush
CodeRush Classic
TestCafe Studio
Logify

Frameworks and Libraries

eXpressApp Framework (XAF)
eXpress Persistent Objects (XPO)
XPO Profiler
Core Libraries

Mobile

UI Controls for Xamarin.Forms
Charts for iOS / Xamarin.iOS
Charts for Android / Xamarin.Android
Grid for Xamarin.Forms (Legacy)
All docs
V19.1

General Information

.NET Subscription

Overview

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Desktop

Controls

WinForms
WPF
VCL
UWP (Windows 10)

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Web

Controls and Extensions

ASP.NET Controls and MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Mainteinance Mode

ASP.NET Core Bootstrap Controls

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
Dashboard
Office File API

Quality Assurance and Productivity

CodeRush
CodeRush Classic
TestCafe Studio
Logify

Frameworks and Libraries

eXpressApp Framework (XAF)
eXpress Persistent Objects (XPO)
XPO Profiler
Core Libraries

Mobile

UI Controls for Xamarin.Forms
Charts for iOS / Xamarin.iOS
Charts for Android / Xamarin.Android
Grid for Xamarin.Forms (Legacy)
19.2 (EAP/Beta)
19.1
18.2
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
Dashboard
Get Started
Basic Concepts and Terminology
Common Features
Create the Designer and Viewer Applications
Create Dashboards
Visual Studio Integration
End-User Documentation
Localization
Redistribution and Deployment
Video Tutorials
Migration Guides
Examples
Member Tables
.NET Framework API Reference
.NET Core API Reference
HTML JS Control API Reference
DevExpress.Dashboard
DevExpress.Dashboard.Data
DevExpress.Dashboard.Designer
AvailableDataSourcesExtension
BindingPanelExtension
ConversionPanelExtension
CreateDashboardExtension
DashboardColorSchemeEditorExtension
DashboardCurrencyEditorExtension
DashboardItemMenuExtension
constructor(dashboardControl)
menuItemClick(menuItemId)
name
processKeyEvent(keyEventType, eventArgs)
start
stop
DashboardMenuItem
DashboardParameterEditorExtension
DashboardTitleEditorExtension
DashboardToolbarGroup
DashboardToolbarItem
DashboardToolboxGroup
DashboardToolboxItem
DataSourceBrowserExtension
DataSourceWizardExtension
InteractivityPanelExtension
MultiQueryDataSourceWizardExtension
OpenDashboardExtension
OptionsPanelExtension
SaveDashboardExtension
ToolboxExtension
UndoRedoExtension
DataSourceWizardExtensionOptions
DevExpress.Dashboard.Model
ASP.NET Client API Reference

DashboardItemMenuExtension Class

A Web Dashboard extension that is a dashboard item menu.

Declaration

export class DashboardItemMenuExtension extends DisposableObject

Inheritance

DisposableObject
DashboardItemMenuExtension

Implements

Inherited Members

constructor(dashboardControl)

Initializes a new instance of the DashboardItemMenuExtension class.

Declaration

constructor(dashboardControl: DashboardControl)

Parameters

Name Type Description
dashboardControl DashboardControl

A Web Dashboard control that owns the extension.

Properties

name Property

Specifies a unique extension name.

Declaration

name: string

Property Value

Type Description
string

A unique extension name. The return value is 'item-menu'.

Remarks

Warning

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

Methods

menuItemClick(menuItemId) Method

Clicks the specified menu item in the dashboard item menu.

menuItemClick(menuItemId: string): void
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

processKeyEvent(keyEventType: 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

start(): void

stop Method

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

Declaration

stop(): void