All docs
V20.1
20.1
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
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.

Customization

  • 3 minutes to read

This topic describes how you can customize the WinForms Dashboard Designer.

Access to Underlying Controls

The WinForms Dashboard Designer uses DevExpress WinForms controls to visualize data within dashboard items. If necessary, you can access these controls and customize their settings to add specific capabilities.

Custom Properties

Custom properties allow you to store custom settings in a dashboard definition. You can read these settings and use these values to implement and embed your functionality into the Dashboard Designer.

The image below displays added custom functionality:

TIP

Documentation: Custom Properties

Ribbon, Toolbar, Popup Menu

In the Dashboard Designer, you can customize a traditional toolbar or a Ribbon interface that allow users to interact with dashboard items or the entire dashboard. You can also manage different popup menus.

The image below displays the Dashboard Description button added to the Ribbon:

Title and Caption

The Dashboard Title and Dashboard Item Caption are areas located on the dashboard surface and contain relevant up-to-date information and command buttons. They are already packed with useful indicators and buttons, but you can also deliberately hide built-in items or add your own.

The image below displays the Description button added to the dashboard title:

Data Source Wizard

The Data Source Wizard allows users to establish a connection and select data from various sources. If necessary, you can skip certain pages, specify the list of available data providers and customize the wizard in other ways.

Item Click

You can use the following API to handle mouse actions and get information about clicked elements:

API Description
DashboardDesigner.DashboardItemClick Occurs when an end-user clicks a dashboard item.
DashboardDesigner.DashboardItemDoubleClick Occurs when an end-user double-clicks a dashboard item.
DashboardDesigner.DashboardItemMouseDown Occurs when the mouse pointer is over the dashboard item and a mouse button is pressed.
DashboardDesigner.DashboardItemMouseUp Occurs when the mouse pointer is over the dashboard item and a mouse button is released.
DashboardDesigner.DashboardItemMouseEnter Occurs when the mouse pointer enters the dashboard item.
DashboardDesigner.DashboardItemMouseLeave Occurs when the mouse pointer leaves the dashboard item.
DashboardDesigner.DashboardItemMouseHover Occurs when the mouse pointer rests on the dashboard item.
DashboardDesigner.DashboardItemMouseMove Occurs when the mouse pointer is moved over the dashboard item.

Custom Interactivity

You can provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting.

The following table lists possible target axes for each dashboard item and supported interactivity capabilities:

Dashboard Item

Target Axes

Selection

Highlighting

GridDashboardItem

DashboardDataAxisNames.DefaultAxis

Dashboard_GreenTick

ChartDashboardItem

DashboardDataAxisNames.ChartArgumentAxis

DashboardDataAxisNames.ChartSeriesAxis

Dashboard_GreenTick

Dashboard_GreenTick

ScatterChartDashboardItem

DashboardDataAxisNames.ChartArgumentAxis

Dashboard_GreenTick

Dashboard_GreenTick

PieDashboardItem

DashboardDataAxisNames.ChartArgumentAxis

DashboardDataAxisNames.ChartSeriesAxis

Dashboard_GreenTick

Dashboard_GreenTick

CardDashboardItem

DashboardDataAxisNames.DefaultAxis

Dashboard_GreenTick

Dashboard_GreenTick

GaugeDashboardItem

DashboardDataAxisNames.DefaultAxis

Dashboard_GreenTick

Dashboard_GreenTick

MapDashboardItem

DashboardDataAxisNames.DefaultAxis

Dashboard_GreenTick

TreemapDashboardItem

DashboardDataAxisNames.DefaultAxis

Dashboard_GreenTick

Dashboard_GreenTick

NOTE

A Grid dashboard item with enabled Cell Merging does not support custom interactivity.