DashboardViewer Methods

Name Description
About()

Activates the control's About dialog box.

BeginUpdateParameters()

Locks the DashboardParameters object until the DashboardViewer.EndUpdateParameters method call.

CanClearMasterFilter(String)

Returns whether or not the specified master filter can be cleared in the current state.

CanPerformDrillDown(String)

Returns whether or not drill down is possible in the current state of the specified dashboard item.

CanPerformDrillUp(String)

Returns whether or not drill up is possible in the current state of the specified dashboard item.

CanSetMasterFilter(String)

Returns whether or not the master filter item allows selecting one or more elements.

CanSetMultiValueMasterFilter(String)

Returns whether or not the master filter item allows selecting multiple elements.

ClearMasterFilter(String)

Clears the specified master filter item.

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 using specified export options.

ExportDashboardItemToExcel(String, Stream, ExcelExportOptions)

Obsolete. 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 specified export options.

ExportDashboardItemToExcel(String, String, ExcelExportOptions)

Obsolete. 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, Stream, ImageExportOptions)

Obsolete. Exports the dashboard item to the specified stream in Image format using the specified Image-specific 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.

ExportDashboardItemToImage(String, String, ImageExportOptions)

Obsolete. Exports the dashboard item to the specified file in Image format using the specified Image-specific 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, Stream, PdfExportOptions)

Obsolete. 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.

ExportDashboardItemToPdf(String, String, PdfExportOptions)

Obsolete. 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(Stream, ImageExportOptions)

Obsolete. 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.

ExportToImage(String, ImageExportOptions)

Obsolete. Exports a dashboard to the specified file in Image format 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(Stream, PdfExportOptions)

Obsolete. 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.

ExportToPdf(String, PdfExportOptions)

Obsolete. Exports a dashboard to the specified file in PDF format using the specified PDF-specific options.

GetAvailableDrillDownValues(String)

Returns axis point tuples identifying elements that can be used to perform drill-down in the specified dashboard item.

GetAvailableFilterValues(String)

Returns axis point tuples identifying elements that can be selected in the current state of the master filter item.

GetAvailablePredefinedRanges(String)

Returns names of the predefined ranges available for the specified Range Filter.

GetAvailableSelections(String)

Obsolete. Returns records identifying elements that can be selected in the current state of the master filter item.

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 dashboard item.

GetCurrentSelection(String)

Returns records identifying currently selected elements in the master filter item.

GetEntireRange(String)

Returns the visible range for the specified Range Filter dashboard item.

GetItemData(String)

Returns the client data for the specified dashboard item.

GetPrintableComponent(String)

Gets a printable component 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.

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<String>)

Returns underlying data for the specified dashboard item by the specified data members.

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.

LoadDashboard(Stream)

Loads a dashboard from a stream.

LoadDashboard(String)

Loads a dashboard from an XML file.

LoadDashboardLayout(Stream)

Loads a dashboard layout 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.

PerformDrillDown(String, AxisPointTuple)

Performs a drill-down for the required element.

PerformDrillDown(String, DashboardDataRow)

Performs a drill-down for the required element.

PerformDrillDown(String, Object)

Performs a drill-down for the required element by its value.

PerformDrillUp(String)

Performs a drill-up in the specified dashboard item.

ReloadData()

Reloads data in the data sources.

ReloadData(Boolean)

Reloads data in the data sources.

ReloadData(IEnumerable<IParameter>)

Obsolete. Reloads data in the data sources.

RestoreDashboardItem()

Restores the item size if an item is expanded to the entire dashboard size (maximized).

SaveDashboardLayout(Stream)

Saves a dashboard layout to a stream.

SaveDashboardLayout(String)

Saves a dashboard layout to an XML file.

SetMasterFilter(String, AxisPointTuple)

Selects required elements in the specified master filter item.

SetMasterFilter(String, IEnumerable<AxisPointTuple>)

Selects the required elements in the specified master filter item.

SetMasterFilter(String, IEnumerable<DashboardDataRow>)

Selects required elements in the specified master filter item.

SetMasterFilter(String, Object)

Selects required elements by their values in the specified master filter item.

SetRange(String, RangeFilterSelection)

Selects the required range in the specified Range Filter dashboard item.

SetRange(String, String)

Selects the specified range in the specified Range Filter dashboard item.

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.

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 CustomizeDashboardItemCaption event that allows you to customize the dashboard item caption content.

UpdateDashboardTitle()

Fires the CustomizeDashboardTitle event that allows you to customize the dashboard title content.