All docs
V20.2
21.1 (EAP/Beta)
20.2
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.

IDashboardControl Methods

Provides API members that are common for DashboardDesigner and DashboardViewer.
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 selecting one or more elements.
CanSetMultiValueMasterFilter(String) Returns whether the master filter item allows selecting multiple elements.
ClearMasterFilter(String) Clears the specified master filter item.
ClearMasterFilterAsync(String) Clears the specified master filter item in asynchronous mode.
ClearMasterFilterAsync(String, CancellationToken) 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) Exports the dashboard item to the specified stream in Image format.
ExportDashboardItemToImage(String, Stream, DashboardImageExportOptions) Exports the dashboard item to the specified stream in Image format using the specified image options.
ExportDashboardItemToImage(String, String) Exports the dashboard item to the specified file in Image format.
ExportDashboardItemToImage(String, String, DashboardImageExportOptions) Exports the dashboard item to the image file using the specified image options.
ExportDashboardItemToPdf(String, Stream) Exports the dashboard item to the specified stream in PDF format.
ExportDashboardItemToPdf(String, Stream, DashboardPdfExportOptions) Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options.
ExportDashboardItemToPdf(String, String) Exports the dashboard item to the specified file in PDF format.
ExportDashboardItemToPdf(String, String, DashboardPdfExportOptions) Exports the dashboard item to the specified file in PDF format using the specified PDF-specific options.
ExportToExcel(Stream) Exports dashboard data to the specified stream in Excel format.
ExportToExcel(Stream, DashboardExcelExportOptions) Exports dashboard data to the specified stream in Excel format.
ExportToExcel(String) Exports dashboard data to the specified file in Excel format.
ExportToExcel(String, DashboardExcelExportOptions) Exports dashboard data to the specified file in Excel format.
ExportToImage(Stream) Exports a dashboard to the specified stream in Image format.
ExportToImage(Stream, DashboardImageExportOptions) Exports a dashboard to the specified stream in Image format using the specified image-specific options.
ExportToImage(String) Exports a dashboard to the specified file in Image format.
ExportToImage(String, DashboardImageExportOptions) Exports a dashboard to the specified image file using the specified image-specific options.
ExportToPdf(Stream) Exports a dashboard to the specified stream in PDF format.
ExportToPdf(Stream, DashboardPdfExportOptions) Exports a dashboard to the specified stream in PDF format using the specified PDF-specific options.
ExportToPdf(String) Exports a dashboard to the specified file in PDF format.
ExportToPdf(String, DashboardPdfExportOptions) Exports a dashboard to the specified file in PDF format using the specified PDF-specific options.
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) Returns underlying data for the specified dashboard item.
GetUnderlyingData(String, IList<AxisPoint>) Returns underlying data for the specified dashboard item by the specified axis points.
GetUnderlyingData(String, IList<AxisPoint>, IList<String>) Returns underlying data for the specified dashboard item by the specified axis points.
GetUnderlyingData(String, IList<UnderlyingDataTargetValue>) Returns underlying data for the specified dashboard item by the specified dimension values.
GetUnderlyingData(String, IList<UnderlyingDataTargetValue>, IList<String>) 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.
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) Performs a drill-down for the required element asynchronously.
PerformDrillDownAsync(String, DashboardDataRow, CancellationToken) Performs a drill-down for the required element asynchronously.
PerformDrillDownAsync(String, AxisPointTuple) Performs a drill-down for the required element asynchronously.
PerformDrillDownAsync(String, AxisPointTuple, CancellationToken) Performs a drill-down for the required element asynchronously.
PerformDrillDownAsync(String, Object) Performs a drill-down for the required element asynchronously.
PerformDrillDownAsync(String, Object, CancellationToken) Performs a drill-down for the required element asynchronously.
PerformDrillUp(String) Performs a drill-up in the specified dashboard item.
PerformDrillUpAsync(String) Performs a drill-down for the required element asynchronously.
PerformDrillUpAsync(String, CancellationToken) Performs a drill-up in the specified dashboard item 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) Reloads data from the specified data source. Accepts data source object as the parameter. The operation is asynchronous.
ReloadDataSourceAsync(IDashboardDataSource, CancellationToken) Reloads data from the specified data source instance. 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.
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.
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) Applies the dashboard state to the dashboard, asynchronously.
SetDashboardStateAsync(DashboardState, CancellationToken) 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) Selects the specified elements in the specified master filter item.
SetMasterFilterAsync(String, AxisPointTuple, 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<DashboardDataRow>, 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, IEnumerable<AxisPointTuple>, CancellationToken) Selects the specified elements in the specified master filter item.
SetMasterFilterAsync(String, Object) Selects the specified elements in the specified master filter item.
SetMasterFilterAsync(String, Object, CancellationToken) 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) Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously.
SetRangeAsync(String, RangeFilterSelection, 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.
SetRangeAsync(String, String, CancellationToken) Selects the specified range in the specified Range Filter or Date Filter dashboard item asynchronously.
SetSelectedTabPage(String) Selects the specified tab page.
SetSelectedTabPage(String, Int32) Selects the tab page specified by its index in the specified tab container.
ShowDashboardParametersForm() Invokes the Dashboard Parameters dialog in the DashboardViewer.
ShowDataInspector(String) Invokes the Data Inspector dialog for the specified dashboard item.
ShowDataInspector(String, InspectedType) Invokes the Data Inspector dialog with a defined data type for the specified dashboard item.
ShowDataInspectorAsync(String) Invokes the Data Inspector dialog for the specified dashboard item asynchronously.
ShowDataInspectorAsync(String, InspectedType) Invokes the Data Inspector dialog with a defined data type 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.
ShowRibbonPrintPreview() Invokes the Ribbon Print Preview Form, which shows the print preview of the dashboard.
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>) Updates all extract data sources in the current dashboard asynchronously. Allows you to specify custom actions to perform after updating the data and file.
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.
See Also