dashboard-devexpress-dot-dashboardwin-dot-idashboardcontrol-dot-underscore-members.md
Provides API members that are common for DashboardDesigner and DashboardViewer.
| Name | Description |
|---|---|
| AllowInspectAggregatedData | Gets or sets whether to display aggregated data in the Data Inspector. |
| AllowInspectRawData | Gets or sets whether to display raw data in the Data Inspector. |
| AllowMaximizeAnimation | Gets or sets whether to enable the animation when you maximize or restore dashboard items. |
| AllowMaximizeDashboardItems | Gets or sets whether end users can maximize dashboard items. |
| AllowPrintDashboard | Gets or sets whether end-users can print or export a dashboard. |
| AllowPrintDashboardItems | Gets or sets whether end-users can print or export dashboard items. |
| AsyncMode | Gets or sets whether DashboardViewer/DashboardDesigner operates in asynchronous mode. |
| CalculateHiddenTotals | Gets or sets whether to calculate totals for the hidden data items. |
| CustomDBCommandInterceptor | Specifies the IDBCommandInterceptor object for the Dashboard control. |
| CustomDBConnectionInterceptor | Specifies the IDBConnectionInterceptor object for the Dashboard control. |
| CustomDBSchemaProviderEx | Allows you to specify a custom schema for the SQL Data Source. |
| Dashboard | Gets or sets the currently opened dashboard. |
| DataSourceOptions | Provides access to options that define the data source options of a DashboardViewer / DashboardDesigner. |
| EnableWaitForm | Gets or sets whether the DashboardViewer / DashboardDesigner displays a Wait Form when a time-consuming operation is performed. |
| ExcelExportOptions | Provides access to options related to exporting a dashboard item to Excel format. |
| GridBestFitMaxRowCount | Gets or sets the number of the Grid dashboard item’s data rows whose content is processed to apply best fit to columns. |
| ImageExportOptions | Provides access to options related to exporting a dashboard/dashboard item to an image. |
| MaximizedDashboardItemName | Gets the name of the maximized dashboard item. |
| Parameters | Provides access to dashboard parameter settings and metadata. |
| PdfExportOptions | Provides access to options related to exporting a dashboard/dashboard item to PDF format. |
| PrintPreviewOptions | Provides access to options related to printing a dashboard/dashboard item. |
| PrintPreviewType | Gets or sets the type of Print Preview used to preview dashboard items or the entire dashboard. |
| UseNeutralFilterMode | Gets or sets whether to show all items in the filter elements deselected by default. |
| UserAction | Gets the end-user action performed on the DashboardViewer/DashboardDesigner. |
| Name | Description |
|---|---|
| BeginUpdateParameters() | Locks the DashboardParameters object until the DashboardViewer.EndUpdateParameters/DashboardDesigner.EndUpdateParameters method call. |
| CanClearMasterFilter(String) | Returns whether the specified master filter can be cleared in the current state. |
| CanPerformDrillDown(String) | Returns whether drill down is possible in the current state of the specified dashboard item. |
| CanPerformDrillUp(String) | Returns whether drill up is possible in the current state of the specified dashboard item. |
| CanSetMasterFilter(String) | Returns whether the master filter item allows users to select one or more elements. |
| CanSetMultiValueMasterFilter(String) | Returns whether the master filter item allows users to select multiple elements. |
| ClearMasterFilter(String) | Clears the specified master filter item. |
| ClearMasterFilterAsync(String, CancellationToken) | Clears the specified master filter item in asynchronous mode. |
| ClearMasterFilterAsync(String) | Clears the specified master filter item in asynchronous mode. |
| EndUpdateParameters() | Unlocks the DashboardParameters object after a call to the DashboardViewer.BeginUpdateParameters method and applies changes made to the parameter settings. |
| ExportDashboardItemToExcel(String, Stream, DashboardExcelExportOptions) | Exports the dashboard item to the specified stream in Excel format. |
| ExportDashboardItemToExcel(String, String, DashboardExcelExportOptions) | Exports the dashboard item to the specified file in Excel format using the specified export options. |
| ExportDashboardItemToImage(String, Stream, DashboardImageExportOptions) | Exports the dashboard item to the specified stream in Image format using the specified image options. |
| ExportDashboardItemToImage(String, Stream) | Exports the dashboard item to the specified stream in Image format. |
| ExportDashboardItemToImage(String, String, DashboardImageExportOptions) | Exports the dashboard item to the image file using the specified image options. |
| ExportDashboardItemToImage(String, String) | Exports the dashboard item to the specified file in Image format. |
| ExportDashboardItemToPdf(String, Stream, DashboardPdfExportOptions) | Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options. |
| ExportDashboardItemToPdf(String, Stream) | Exports the dashboard item to the specified stream in PDF format. |
| ExportDashboardItemToPdf(String, String, DashboardPdfExportOptions) | Exports the dashboard item to the specified file in PDF format using the specified PDF-specific options. |
| ExportDashboardItemToPdf(String, String) | Exports the dashboard item to the specified file in PDF format. |
| ExportToExcel(Stream, DashboardExcelExportOptions) | Exports dashboard data to the specified stream in Excel format. |
| ExportToExcel(Stream) | Exports dashboard data to the specified stream in Excel format. |
| ExportToExcel(String, DashboardExcelExportOptions) | Exports dashboard data to the specified file in Excel format. |
| ExportToExcel(String) | Exports dashboard data to the specified file in Excel format. |
| ExportToImage(Stream, DashboardImageExportOptions) | Exports a dashboard to the specified stream in Image format using the specified image-specific options. |
| ExportToImage(Stream) | Exports a dashboard to the specified stream in Image format. |
| ExportToImage(String, DashboardImageExportOptions) | Exports a dashboard to the specified image file using the specified image-specific options. |
| ExportToImage(String) | Exports a dashboard to the specified file in Image format. |
| ExportToPdf(Stream, DashboardPdfExportOptions) | Exports a dashboard to the specified stream in PDF format using the specified PDF-specific options. |
| ExportToPdf(Stream) | Exports a dashboard to the specified stream in PDF format. |
| ExportToPdf(String, DashboardPdfExportOptions) | Exports a dashboard to the specified file in PDF format using the specified PDF-specific options. |
| ExportToPdf(String) | Exports a dashboard to the specified file in PDF format. |
| GetAvailableDrillDownValues(String) | Returns data identifying the elements that can be used to perform drill-down in the specified dashboard item. |
| GetAvailableDrillDownValuesAsync(String) | Returns data identifying the elements that can be used to perform drill-down in the specified dashboard item. Asynchronous method. |
| GetAvailableFilterValues(String) | Returns axis point tuples identifying elements that can be selected in the current state of the master filter item. |
| GetAvailableFilterValuesAsync(String) | Gets the data (axis point tuples) that identifies selectable elements in the current state of the master filter item. |
| GetAvailablePredefinedRanges(String) | Returns names of the predefined ranges available for the specified Range Filter / Date Filter. |
| GetCurrentDrillDownValues(String) | Returns an axis point tuple identifying the current drill-down state. |
| GetCurrentFilterValues(String) | Returns axis point tuples identifying currently selected elements in the master filter item. |
| GetCurrentPredefinedRange(String) | Returns the name of the currently selected predefined range. |
| GetCurrentRange(String) | Returns the selected range for the specified Range Filter or Date Filter dashboard item. |
| GetCurrentSelection(String) | Returns records identifying currently selected elements in the master filter item. |
| GetDashboardState() | Gets the current dashboard state. |
| GetEntireRange(String) | Returns the visible range for the specified Range Filter or Date Filter dashboard item. |
| GetEntireRangeAsync(String) | Returns the visible range for the specified Range Filter or Date Filter dashboard item. |
| GetItemData(String) | Returns the client data for the specified dashboard item. |
| GetItemDataAsync(String) | Obtains the displayed data for the specified dashboard item asynchronously. |
| GetPrintableControl(String) | Gets a printable control corresponding to the specified dashboard item. |
| GetSelectedTabPage(String) | Gets the selected page in the specified tab container. |
| GetSelectedTabPageIndex(String) | Gets the index of the selected page in the specified tab container. |
| GetUnderlyingControl(String) | Gets the underlying control used to visualize data within the specified dashboard item. |
| GetUnderlyingControls() | Gets the underlying controls used to visualize data within the dashboard items. |
| GetUnderlyingData(String, IList<AxisPoint>, IList<String>) | Returns underlying data for the specified dashboard item by the specified axis points. |
| GetUnderlyingData(String, IList<AxisPoint>) | Returns underlying data for the specified dashboard item by the specified axis points. |
| GetUnderlyingData(String, IList<UnderlyingDataTargetValue>, IList<String>) | Returns underlying data for the specified dashboard item by the specified dimension values. |
| GetUnderlyingData(String, IList<UnderlyingDataTargetValue>) | Returns underlying data for the specified dashboard item by the specified dimension values. |
| GetUnderlyingData(String, IList<String>) | Returns underlying data for the specified dashboard item by the specified data members. |
| GetUnderlyingData(String) | Returns underlying data for the specified dashboard item. |
| LoadDashboard(Stream) | Loads a dashboard from a stream. |
| LoadDashboard(String) | Loads a dashboard from an XML file. |
| LoadDashboardLayout(Stream) | Loads a dashboard layout (layout items and layout containers) from a stream. |
| LoadDashboardLayout(String) | Loads a dashboard layout from an XML file. |
| MaximizeDashboardItem(String) | Expands the specified dashboard item to the entire dashboard size to examine data in greater detail. |
| MaximizeDashboardItemAsync(String) | Expands the specified dashboard item to the entire dashboard size in an asynchronous task. |
| PerformDrillDown(String, DashboardDataRow) | Performs a drill-down for the required element. |
| PerformDrillDown(String, AxisPointTuple) | Performs a drill-down for the required element. |
| PerformDrillDown(String, Object) | Performs a drill-down for the required element by its value. |
| PerformDrillDownAsync(String, DashboardDataRow, CancellationToken) | Performs a drill-down for the required element asynchronously. |
| PerformDrillDownAsync(String, DashboardDataRow) | Performs a drill-down for the required element asynchronously. |
| PerformDrillDownAsync(String, AxisPointTuple, CancellationToken) | Performs a drill-down for the required element asynchronously. |
| PerformDrillDownAsync(String, AxisPointTuple) | Performs a drill-down for the required element asynchronously. |
| PerformDrillDownAsync(String, Object, CancellationToken) | Performs a drill-down for the required element asynchronously. |
| PerformDrillDownAsync(String, Object) | Performs a drill-down for the required element asynchronously. |
| PerformDrillUp(String) | Performs a drill-up in the specified dashboard item. |
| PerformDrillUpAsync(String, CancellationToken) | Performs a drill-up in the specified dashboard item asynchronously. |
| PerformDrillUpAsync(String) | Performs a drill-down for the required element asynchronously. |
| ReloadData() | Reloads data in the data sources. |
| ReloadData(Boolean) | Reloads data in the data sources. |
| ReloadData(String) | Reloads data from the data source for the specified dashboard item. |
| ReloadDataAsync() | Reloads data in the data sources asynchronously. |
| ReloadDataAsync(String) | Reloads data from the data source for the specified dashboard item asynchronously. |
| ReloadDataAsync(CancellationToken) | Reloads data in the data sources asynchronously. |
| ReloadDataSource(IDashboardDataSource) | Reloads data from the specified data source instance. |
| ReloadDataSource(String) | Reloads data from the specified data source. Accepts data source component name as the parameter. |
| ReloadDataSourceAsync(IDashboardDataSource, CancellationToken) | Reloads data from the specified data source instance. The operation is asynchronous. You can propagate a notification to cancel it. |
| ReloadDataSourceAsync(IDashboardDataSource) | Reloads data from the specified data source. Accepts data source object as the parameter. The operation is asynchronous. |
| ReloadDataSourceAsync(String, CancellationToken) | Reloads data from the specified data source. Accepts data source component name as the parameter. The operation is asynchronous. You can propagate a notification to cancel it. |
| ReloadDataSourceAsync(String) | Reloads data from the specified data source. Accepts data source component name as the parameter. The operation is asynchronous. |
| RestoreDashboardItem() | Restores the item size if an item is expanded to the entire dashboard size (maximized). |
| RestoreDashboardItemAsync() | Restores the item size if an item is expanded to the entire dashboard size (maximized) in an asynchronous task. |
| SaveDashboardLayout(Stream) | Saves a dashboard layout (layout items and layout containers) to a stream. |
| SaveDashboardLayout(String) | Saves a dashboard layout to a separate XML file. |
| SetDashboardState(DashboardState) | Applies the dashboard state to the loaded dashboard. |
| SetDashboardStateAsync(DashboardState, CancellationToken) | Applies the dashboard state to the dashboard, asynchronously. |
| SetDashboardStateAsync(DashboardState) | Applies the dashboard state to the dashboard, asynchronously. |
| SetMasterFilter(String, AxisPointTuple) | Selects required elements in the specified master filter item. |
| SetMasterFilter(String, IEnumerable<DashboardDataRow>) | Selects required elements in the specified master filter item. |
| SetMasterFilter(String, IEnumerable<AxisPointTuple>) | Selects required elements in the specified master filter item. |
| SetMasterFilter(String, Object) | Selects the elements by their values in the specified master filter item. |
| SetMasterFilterAsync(String, AxisPointTuple, CancellationToken) | Selects the specified elements in the specified master filter item. |
| SetMasterFilterAsync(String, AxisPointTuple) | Selects the specified elements in the specified master filter item. |
| SetMasterFilterAsync(String, IEnumerable<DashboardDataRow>, CancellationToken) | Selects the specified elements in the specified master filter item. |
| SetMasterFilterAsync(String, IEnumerable<DashboardDataRow>) | Selects the specified elements in the specified master filter item. |
| SetMasterFilterAsync(String, IEnumerable<AxisPointTuple>, CancellationToken) | Selects the specified elements in the specified master filter item. |
| SetMasterFilterAsync(String, IEnumerable<AxisPointTuple>) | Selects the specified elements in the specified master filter item. |
| SetMasterFilterAsync(String, Object, CancellationToken) | Selects the specified elements in the specified master filter item. |
| SetMasterFilterAsync(String, Object) | Selects the specified elements in the specified master filter item. |
| SetRange(String, RangeFilterSelection) | Selects the required range in the specified Range Filter or Date Filter dashboard item. |
| SetRange(String, String) | Selects the specified range in the specified Range Filter or Date Filter dashboard item. |
| SetRangeAsync(String, RangeFilterSelection, CancellationToken) | Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously. |
| SetRangeAsync(String, RangeFilterSelection) | Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously. |
| SetRangeAsync(String, String, CancellationToken) | Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously. |
| SetRangeAsync(String, String) | Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously. |
| SetSelectedTabPage(String, Int32) | Selects the tab page specified by its index in the specified tab container. |
| SetSelectedTabPage(String) | Selects the specified tab page. |
| ShowDashboardParametersForm() | Invokes the Dashboard Parameters dialog in the DashboardViewer. |
| ShowDataInspector(String, InspectedType) | Invokes the Data Inspector dialog with a defined data type for the specified dashboard item. |
| ShowDataInspector(String) | Invokes the Data Inspector dialog for the specified dashboard item. |
| ShowDataInspectorAsync(String, InspectedType) | Invokes the Data Inspector dialog with a defined data type for the specified dashboard item asynchronously. |
| ShowDataInspectorAsync(String) | Invokes the Data Inspector dialog for the specified dashboard item asynchronously. |
| ShowExportDashboardDialog(DashboardExportFormat) | Invokes the dialog that allows end-users to export the entire dashboard to the specified format. |
| ShowExportDashboardItemDialog(String, DashboardExportFormat) | Invokes the dialog that allows end-users to export the dashboard item to the specified format. |
| ShowPrintPreview() | Invokes the Print Preview, which shows the print preview of the dashboard. |
| ShowPrintPreview(String) | Invokes the Print Preview window for the specified dashboard item. |
| ShowRibbonPrintPreview() | Invokes the Ribbon Print Preview Form, which shows the print preview of the dashboard. |
| ShowRibbonPrintPreview(String) | Invokes the Ribbon Print Preview window for the specified dashboard item. |
| UpdateDashboardItemCaption(String) | Fires the DashboardViewer.CustomizeDashboardItemCaption/DashboardDesigner.CustomizeDashboardItemCaption event that allows you to customize the dashboard item caption content. |
| UpdateDashboardTitle() | Fires the DashboardViewer.CustomizeDashboardTitle/DashboardDesigner.CustomizeDashboardTitle event that allows you to customize the dashboard title content. |
| UpdateExtractDataSourcesAsync(Action<String, ExtractUpdateResult>, Action<String, ExtractUpdateResult>, String[]) | Updates the specified extract data sources in the current dashboard asynchronously. Allows you to set custom actions to perform after updating the data and file. |
| UpdateExtractDataSourcesAsync(Action<String, ExtractUpdateResult>, Action<String, ExtractUpdateResult>) | Updates all extract data sources in the current dashboard asynchronously. Allows you to specify custom actions to perform after updating the data and file. |
| Name | Description |
|---|---|
| AsyncDataLoading | Allows you to provide data for the DashboardObjectDataSource in asynchronous mode. |
| AsyncExcelDataSourceBeforeFill | Allows you to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files asynchronously. |
| AsyncValidateCustomSqlQuery | Allows you to validate a custom SQL query of the DashboardSqlDataSource in asynchronous mode. |
| BeforeExportDocument | Allows you to hide specific dashboard items when printing or exporting the entire dashboard. |
| ConfigureDataConnection | Allows you to customize connection settings before the DashboardViewer/DashboardDesigner connects to a data store (database, OLAP cube, etc.). |
| ConnectionError | Allows to override the default behavior if data store connection fails with current connection parameters. |
| CustomAssemblyLoading | Occurs before a custom assembly is loaded for use as DashboardEFDataSource. |
| CustomDashboardItemControlCreating | Occurs when a dashboard control visualizes a custom item. |
| CustomExport | Allows you to customize the exported document. |
| CustomFilterExpression | Allows you to include WHERE clauses into DashboardSqlDataSource queries. |
| CustomizeDashboardItemCaption | Allows you to customize the dashboard item caption at runtime. |
| CustomizeDashboardTitle | Allows you to customize the dashboard title at runtime. |
| CustomizeExportDocument | Allows you to customize the exported document. |
| CustomPalette | Allows you to substitute the default palette containing colors used to paint dashboard item elements. |
| CustomParameters | Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing. |
| DashboardChanged | Occurs after a dashboard has been opened. |
| DashboardCustomPropertyChanged | Occurs when the custom property value in the Dashboard Viewer / Dashboard Designer is changed. |
| DashboardItemBeforeControlDisposed | Allows you to access underlying WinForms controls. |
| DashboardItemClick | Occurs when an end user clicks a dashboard item. |
| DashboardItemControlCreated | Allows you to access underlying WinForms controls. |
| DashboardItemControlUpdated | Allows you to access underlying WinForms controls. |
| DashboardItemDoubleClick | Occurs when an end user double-clicks a dashboard item. |
| DashboardItemElementCustomColor | Allows you to color the required dashboard item elements using the specified colors. |
| DashboardItemMaximizedStateChanged | Fires when an item becomes maximized or restores its original size. |
| DashboardItemMouseDown | Occurs when the mouse pointer is over the dashboard item and a mouse button is pressed. |
| DashboardItemMouseEnter | Occurs when the mouse pointer enters the dashboard item. |
| DashboardItemMouseHover | Occurs when the mouse pointer rests on the dashboard item. |
| DashboardItemMouseLeave | Occurs when the mouse pointer leaves the dashboard item. |
| DashboardItemMouseMove | Occurs when the mouse pointer is moved over the dashboard item. |
| DashboardItemMouseUp | Occurs when the mouse pointer is over the dashboard item and a mouse button is released. |
| DashboardItemMouseWheel | Occurs when the mouse wheel moves while the dashboard item has focus. |
| DashboardItemSelectionChanged | Occurs after the selection within the dashboard item is changed. |
| DashboardItemVisualInteractivity | Allows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting. |
| DashboardLoaded | Occurs after the dashboard is loaded to the DashboardViewer / DashboardDesigner. |
| DashboardStateChanged | Occurs after the current dashboard state in the DashboardViewer / DashboardDesigner is changed. |
| DataInspectorFormClosing | Occurs before the Data Inspector window closes. Allows you to access the window’s grid controls. |
| DataInspectorFormLoad | Occurs before the Data Inspector window displays. Allows you to access the window’s grid controls and change their settings. |
| DataLoading | Allows you to provide data for the DashboardObjectDataSource. |
| DataLoadingError | Allows you to suppress the form containing errors that occur during data loading. |
| DrillDownPerformed | Occurs after drill-down is performed. |
| DrillUpPerformed | Occurs after a drill-up is performed. |
| ExportFormShowing | Occurs when the Export Form is about to be displayed, and allows you to cancel the action. |
| Initialized | Handle this event to get the dashboard item data, and apply master filter and dashboard state in asynchronous mode. |
| LayoutChanged | Occurs after the dashboard layout is changed. |
| MasterFilterCleared | Occurs when an end user clears the selection in the master filter item. |
| MasterFilterDefaultValues | Allows you to apply default filtering to master filter items. |
| MasterFilterSet | Occurs when an end user changes the state of the master filter. |
| PopupMenuShowing | Allows you to customize the pop-up menu that users invoke in the dashboard control. |
| PrintPreviewShowing | Allows you to customize the Print Preview window at runtime. |
| RangeFilterDefaultValue | Allows you to specify the default selected range in the Range Filter dashboard item. |
| SelectedTabPageChanged | Occurs when the selected tab page is changed. |
| SetInitialDashboardState | Allows you to specify the initial dashboard state when loading a dashboard. |
| ValidateCustomSqlQuery | Allows you to validate a custom SQL query of the DashboardSqlDataSource. |
See Also