DevExpress.DashboardWin Namespace

Contains classes that implement the DashboardDesigner and DashboardViewer controls for Windows Forms.

Assembly: DevExpress.Dashboard.v20.1.Win.dll

Classes

Name Description
CardControl A Card control that is used to visualize a Card dashboard item's data.
CardCustomDisplayTextEventArgs Provides data for the CardControl.CustomDisplayText event.
CardPrintingOptions Obsolete. Contains settings that specify parameters affecting how the Card dashboard item is printed or exported.
ChartPrintingOptions Obsolete. Contains settings that specify parameters affecting how the Chart dashboard item is printed or exported.
CustomizeDashboardCaptionBaseEventArgs Base class for EventArgs passed to the CustomizeDashboardTitle and CustomizeDashboardItemCaption events of DashboardDesigner and DashboardViewer controls.
CustomizeDashboardItemCaptionEventArgs Provides data for the CustomizeDashboardItemCaption and CustomizeDashboardItemCaption events.
CustomizeDashboardTitleEventArgs Provides data for the CustomizeDashboardTitle and CustomizeDashboardTitle events.
CustomizeDashboardTitleTextEventArgs Provides data for the DashboardViewer.CustomizeDashboardTitleText and DashboardDesigner.CustomizeDashboardTitleText events.
CustomPropertyHistoryItem A basic implementation for a history item.
DashboardBarItemCategory Identifies a page category in the Ribbon UI or a contextual toolbar in Bar UI.
DashboardBeforeExportEventArgs Obsolete. Provides data for the BeforeExport events.
DashboardClosingEventArgs Provides data for the DashboardDesigner.DashboardClosing event.
DashboardCreatingEventArgs Provides data for the DashboardDesigner.DashboardCreating event.
DashboardDataSourceWizardSettings For internal use. Provides access to the Data Source wizard settings. Use the DashboardDesignerDataSourceWizardSettings class instance instead.
DashboardDesigner A Dashboard Designer control that constitutes a designer application for creating dashboards.
DashboardDesignerBarExtensions static Provides extension methods for Ribbon and Toolbar customization.
DashboardDesignerDataSourceWizardSettings Contains settings used to customize the Data Source wizard used to create new data sources in the DashboardDesigner.
DashboardDesignerLayoutSettings static Provides access to dashboard layout settings of the DashboardDesigner control.
DashboardExportFormShowingEventArgs Provides data for the ExportFormShowing events.
DashboardItemControlEventArgs Provides data for events related to controls used to visualize data in dashboard items.
DashboardItemElementCustomColorEventArgs Provides data for the DashboardViewer.DashboardItemElementCustomColor event.
DashboardItemMaximizedStateChangedEventArgs Provides data for the DashboardViewer.DashboardItemMaximizedStateChanged and DashboardDesigner.DashboardItemMaximizedStateChanged events.
DashboardItemMouseActionEventArgs Provides data for events related to mouse actions.
DashboardItemMouseEventArgs Provides data for events related to mouse movement or actions.
DashboardItemMouseHitTestEventArgs Base class for classes that contain event data and provide access to dashboard item's client and underlying data for the visual element located under the test point.
DashboardItemPrintingOptions Contains settings that specify printing and exporting parameters related to individual dashboard items.
DashboardItemSelectedEventArgs Provides data for the DashboardItemSelected event.
DashboardItemSelectionChangedEventArgs Provides data for the DashboardDesigner.DashboardItemSelectionChanged / DashboardViewer.DashboardItemSelectionChanged events.
DashboardItemVisualInteractivityEventArgs Provides data for the DashboardDesigner.DashboardItemVisualInteractivity / DashboardViewer.DashboardItemVisualInteractivity events.
DashboardLoadedEventArgs Provides data for the DashboardLoaded events.
DashboardLockedException The exception that occurs when the dashboard is locked for further modifications.
DashboardOpeningEventArgs Provides data for the DashboardDesigner.DashboardOpening event.
DashboardParameterDescriptor Contains the parameter settings and metadata.
DashboardParameters Represents a collection of DashboardParameterDescriptor objects.
DashboardPopupMenu Represents a dashboard popup menu, managed by a BarManager or RibbonControl.
DashboardPopupMenuShowingEventArgs Provides data for the DashboardViewer.PopupMenuShowing and the DashboardDesigner.PopupMenuShowing events.
DashboardPrintingOptions Obsolete. Contains settings that specify parameters affecting how the dashboard (dashboard item) is printed or exported.
DashboardRibbonPage Contains values that identifies a ribbon page when the Dashboard Designer uses Ribbon UI.
DashboardSavedEventArgs Provides data for the DashboardDesigner.DashboardSaved event.
DashboardSavingEventArgs Provides data for the DashboardDesigner.DashboardSaving event.
DashboardStateChangedEventArgs Provides data for the DashboardStateChanged event.
DashboardToolbar Contains values that identifies a toolbar when the Dashboard Designer uses Bar UI.
DashboardToolbarItem An element, contained in the dashboard title or dashboard item caption, such as a command button.
DashboardToolbarItemClickEventArgs Provides data for the action performed after clicking the command button in the dashboard title or dashboard item caption.
DashboardToolbarMenuItem Drop-down menu element, contained in the dashboard title or dashboard item caption.
DashboardViewer A Dashboard Viewer control used to embed dashboards created in the Dashboard Designer into a WinForms application.
DataInspectorFormClosingEventArgs Provides data for the DashboardViewer.DataInspectorFormClosing and DashboardDesigner.DataInspectorFormClosing events.
DataInspectorFormLoadEventArgs Provides data for the DashboardViewer.DataInspectorFormLoad and DashboardDesigner.DataInspectorFormLoad events.
DateFilterControl A Date Filter control used to visualize a Date Filter dashboard item's data
DocumentContentPrintingOptions Obsolete. Contains options specific to printing and exporting additional content.
EditExtractOptionsContext Provides data for the Data Source Wizard pages related to the ExtractDataSource type.
ExcelDataSourceBeforeFillEventArgs Provides data for the DashboardDesigner.AsyncExcelDataSourceBeforeFill and DashboardViewer.AsyncExcelDataSourceBeforeFill events.
ExtractDataSourceUIHelper static Allows you to invoke the Data Source Wizard for the ExtractDataSource type.
GaugeContext Provides a connection between data item containers from the Gauges section and underlying control's gauges.
GaugePrintingOptions Obsolete. Contains settings that specify parameters affecting how the Gauge dashboard item is printed or exported.
GridContext Provides a connection between data item containers from the Columns section and an underlying control's columns.
GridPrintingOptions Obsolete. Contains settings that specify parameters affecting how the Grid dashboard item is printed or exported.
MapPrintingOptions Obsolete. Contains settings that specify parameters affecting how Map dashboard items are printed or exported.
OptionsBase Serves as the base class for classes containing specific printing options.
ParameterValue Contains the parameter value and display text.
PiePrintingOptions Obsolete. Contains settings that specify parameters affecting how the Pie dashboard item is printed or exported.
PivotPrintingOptions Obsolete. Contains settings that specify parameters affecting how the Pivot dashboard item is printed or exported.
PrintingFontInfo Obsolete. Contains the font settings of the printed or exported document.
PrintPreviewShowingEventArgs Provides data for the DashboardDesigner.PrintPreviewShowing and DashboardViewer.PrintPreviewShowing events.
RangeFilterPrintingOptions Obsolete. Contains settings that specify parameters affecting how the Range Filter dashboard item is printed or exported.
SelectedDataSourceChangedEventArgs Provides data for the DashboardDesigner.SelectedDataSourceChanged event.
SetInitialDashboardStateEventArgs Provides data for the DashboardDesigner.SetInitialDashboardState and DashboardViewer.SetInitialDashboardState events.
TreemapPrintingOptions Obsolete. Contains settings that specify parameters affecting how the Treemap dashboard item is printed or exported.
UnderlyingDataTargetValue Represents the dimension value used to obtain the underlying data.

Interfaces

Name Description
IDashboardControl Provides API members that are common for DashboardDesigner and DashboardViewer.
IDashboardToolbarItem Base interface for items located in the dashboard title, dashboard item captions and drop-down menus
IDataSourceWizardCustomizationService Provides the capability to customize the Data Source wizard.
IExtractDataSourceWizardCustomization Provides the capability to customize the Data Source wizard for the Extract Data Source.
IHistoryItem When implemented, represents a history item.

Delegates

Name Description
CardCustomDisplayTextEventHandler References a method that handles the CardControl.CustomDisplayText event.
CustomizeDashboardItemCaptionEventHandler A method that handles the DashboardViewer.CustomizeDashboardItemCaption and DashboardDesigner.CustomizeDashboardItemCaption
CustomizeDashboardTitleEventHandler A method that handles the DashboardViewer.CustomizeDashboardTitle and DashboardDesigner.CustomizeDashboardTitle events.
CustomizeDashboardTitleTextEventHandler References a method that handles the DashboardViewer.CustomizeDashboardTitleText event.
DashboardBeforeExportEventHandler Obsolete. References a method that handles the BeforeExport event.
DashboardClosingEventHandler References a method that handles the DashboardDesigner.DashboardClosing event.
DashboardCreatingEventHandler References a method that handles the DashboardDesigner.DashboardCreating event.
DashboardExportFormShowingEventHandler References a method that handles the ExportFormShowing events.
DashboardItemBeforeControlDisposedEventHandler References a method that handles the DashboardViewer.DashboardItemBeforeControlDisposed event.
DashboardItemControlCreatedEventHandler References a method that handles the DashboardViewer.DashboardItemControlCreated event.
DashboardItemControlUpdatedEventHandler References a method that handles the DashboardViewer.DashboardItemControlUpdated event.
DashboardItemElementCustomColorEventHandler References a method that handles the DashboardViewer.DashboardItemElementCustomColor event.
DashboardItemMaximizedStateChangedEventHandler References a method that handles the DashboardViewer.DashboardItemMaximizedStateChanged and DashboardDesigner.DashboardItemMaximizedStateChanged events.
DashboardItemMouseActionEventHandler References a method that handles the events related to mouse actions.
DashboardItemMouseEventHandler References a method that handles the events related to mouse movement or actions.
DashboardItemSelectedEventHandler References a method that handles the DashboardDesigner.DashboardItemSelected event.
DashboardItemSelectionChangedEventHandler References a method that handles the DashboardDesigner.DashboardItemSelectionChanged / DashboardViewer.DashboardItemSelectionChanged events.
DashboardItemVisualInteractivityEventHandler References a method that handles the DashboardViewer.DashboardItemVisualInteractivity event.
DashboardLoadedEventHandler References a method that handles the DashboardLoaded events.
DashboardOpeningEventHandler References a method that handles the DashboardDesigner.DashboardOpening event.
DashboardPopupMenuShowingEventHandler A method that handles the DashboardDesigner.PopupMenuShowing and the DashboardViewer.PopupMenuShowing events.
DashboardSavedEventHandler References a method that handles the DashboardDesigner.DashboardSaved event.
DashboardSavingEventHandler References a method that handles the DashboardDesigner.DashboardSaving event.
DashboardStateChangedEventHandler References a method that handles the DashboardStateChanged event.
DataInspectorFormClosingEventHandler References a method that handles the DashboardViewer.DashboardSaDataInspectorFormClosing and DashboardDesigner.DashboardSaDataInspectorFormClosing events.
DataInspectorFormLoadEventHandler References a method that handles the DashboardViewer.DataInspectorFormLoad and DashboardDesigner.DataInspectorFormLoad events.
ExcelDataSourceBeforeFillEventHandler A method that will handle the DashboardDesigner.AsyncExcelDataSourceBeforeFill and DashboardViewer.AsyncExcelDataSourceBeforeFill events.
PrintPreviewShowingEventHandler References a method that handles the DashboardDesigner.PrintPreviewShowing and DashboardViewer.PrintPreviewShowing events.
SelectedDataSourceChangedEventHandler References a method that handles the DashboardDesigner.SelectedDataSourceChanged event.
SetInitialDashboardStateEventHandler References a method that handles the DashboardDesigner.SetInitialDashboardState and DashboardViewer.SetInitialDashboardState events.

Enums

Name Description
ChartPrintingSizeMode Obsolete. Lists values used to specify how a Chart dashboard item should be resized when being printed or exported.
DashboardActionOnClose Lists values used to specify the required action when the currently opened dashboard is being closed.
DashboardArea Lists values that identify the dashboard area.
DashboardButtonType Lists values that identify types of dashboard command buttons.
DashboardDesignerDataSourceType Lists values used to specify data source types available in the Data Source wizard.
DashboardItemArea Lists values that identify the dashboard item area.
DashboardPrintingFilterState Obsolete. Lists values that specify the filter state's location on the printed or exported document.
DashboardPrintingPageLayout Obsolete. Lists values that specify the page orientation used to print or export a dashboard (dashboard item).
DashboardPrintingScaleMode Obsolete. Lists values that specify the scale mode used to print or export the dashboard (dashboard item).
DashboardPrintPreviewType Lists values that specify the type of the Print Preview.
DashboardSaveCommand Lists values that specify save commands.
DashboardSelectionMode Lists values that specify the selection mode for the Master-Filtering feature.
DashboardSqlDataProvider Lists values used to specify SQL data providers available in the Data Source wizard.
MapPrintingSizeMode Obsolete. Lists values used to specify how a Map dashboard item should be resized when being printed or exported.
ParameterValueType Lists values used to specify the type of dashboard parameter value.
RangeFilterPrintingSizeMode Obsolete. Lists values used to specify how a range filter dashboard item should be resized when being printed or exported.
TreemapPrintingSizeMode Obsolete. Lists values used to specify how a Treemap dashboard item should be resized when being printed or exported.
UserAction Lists values that specify end-user actions on the DashboardDesigner or DashboardViewer.