This version of the .NET API documentation is deprecated. A new version can be found at https://www.exagoaccess.com/api-docs/.
The DashboardReport class allows Dashboards to be manipulated from the host application. This class does not need to be instantiated, it should be retrieved using methods defined in ReportObjectFactory. The DashboardReport class is derived from the ReportObject abstract class.
A DashboardReport object has the following properties. Properties that appear as hyperlinks below require constants or enums which are documented in the Constants and Enumerators article.
|AllowOutputCSV||boolean||no||a boolean value that when true enables the Dashboard to be exported as a CSV file|
|AllowOutuputHtml||boolean||no||a boolean value that when true enables the Dashboard to be exported as an HTML file (runs in the Web Application user interface)|
|AllowOutputRTF||boolean||no||a boolean value that when true enables the Dashboard to be exported as an RTF file|
|AllowOutputPDF||boolean||no||a boolean value that when true enables the Dashboard to be exported as a PDF file|
|AllowOutputExcel||boolean||no||a boolean value that when true enables the Dashboard to be exported as an Excel workbook|
|Id||string||yes||the unique ID of the Dashboard|
|ExportType||ExportType||yes||an ExportType value which sets the desired export types for the Dashboard|
|Description||string||yes||the the Description text for the Dashboard|
|ReportTreeShortcut||TreeShortcut||yes||TreeShortcut value which sets the default action to take when the Dashboard is accessed from the Web Application user interface|
|Name||string||no||fully qualified name (includes folder names) for the Dashboard|
The following properties set the canvas formatting such as background colors and tile borders
CanvasFormat.CanvasBackgroundColor = "#ff4c00";
|ReportItems||ReportItem||yes||A list of ReportItem objects, each representing a report contained within the Dashboard.|
To find the index of a particular report on a Dashboard:
- Enter the Dashboard Designer.
- Press Ctrl+Shift+I.
- Click on the desired report. The index will appear in the reports title bar.
A DashboardReport object has no methods.
ReportItem Class DEPRECATED
The ReportItem class represents a report that is contained within a composite report such as a Dashboard.
A ReportItem object has the following properties:
- Report: The fully qualified name of the report that this ReportItem represents.
The ReportItem object has the following methods:
void SetFilterValue(string filterName, wrFilterOperator filterOperator, List<string> filterValues)
Set the value for a promptable filter that exists on this report
The number of entries in filterValues depends on the filter operator.
void SetParameterValue(string parameterName, string parameterValue)
Set the value for a promptable parameter that exists on this report