Skip to main content
All docs
V24.1

DashboardExporter Members

Allows you to implement server export of a dashboard or dashboard items for all platforms.

Constructors

Name Description
DashboardExporter() Initializes a new instance of the DashboardExporter class.

Methods

Name Description
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
ExportDashboardItemToExcel(Dashboard, String, Stream, DashboardState, DashboardExcelExportOptions) Exports a dashboard item’s data to the specified stream in Excel format.
ExportDashboardItemToExcel(Dashboard, String, String, DashboardState, DashboardExcelExportOptions) Exports a dashboard item’s data to the specified Excel file.
ExportDashboardItemToExcel(Stream, String, Stream, DashboardState, DashboardExcelExportOptions) Exports a dashboard item’s data to the specified stream in Excel format.
ExportDashboardItemToExcel(Stream, String, String, DashboardState, DashboardExcelExportOptions) Exports a dashboard item’s data to the specified Excel file.
ExportDashboardItemToExcel(String, String, Stream, DashboardState, DashboardExcelExportOptions) Exports a dashboard item’s data to the specified stream in Excel format.
ExportDashboardItemToExcel(String, String, String, DashboardState, DashboardExcelExportOptions) Exports a dashboard item’s data to the specified Excel file.
ExportDashboardItemToImage(Dashboard, String, Stream, Nullable<Size>, DashboardState, DashboardImageExportOptions) Exports a dashboard item’s data to the specified stream in Image format.
ExportDashboardItemToImage(Dashboard, String, String, Nullable<Size>, DashboardState, DashboardImageExportOptions) Exports a dashboard item’s data to the specified Image file.
ExportDashboardItemToImage(Stream, String, Stream, Nullable<Size>, DashboardState, DashboardImageExportOptions) Exports a dashboard item’s data to the specified stream in Image format.
ExportDashboardItemToImage(Stream, String, String, Nullable<Size>, DashboardState, DashboardImageExportOptions) Exports a dashboard item’s data to the specified Image file.
ExportDashboardItemToImage(String, String, Stream, Nullable<Size>, DashboardState, DashboardImageExportOptions) Exports a dashboard item’s data to the specified stream in Image format.
ExportDashboardItemToImage(String, String, String, Nullable<Size>, DashboardState, DashboardImageExportOptions) Exports a dashboard item’s data to the specified Image file.
ExportDashboardItemToPdf(Dashboard, String, Stream, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Exports a dashboard item’s data to the specified stream in PDF format.
ExportDashboardItemToPdf(Dashboard, String, String, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Exports a dashboard item’s data to the specified PDF file.
ExportDashboardItemToPdf(Stream, String, Stream, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Exports a dashboard item’s data to the specified stream in PDF format.
ExportDashboardItemToPdf(Stream, String, String, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Exports a dashboard item’s data to the specified PDF file.
ExportDashboardItemToPdf(String, String, Stream, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Exports a dashboard item’s data to the specified stream in PDF format.
ExportDashboardItemToPdf(String, String, String, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Exports a dashboard item’s data to the specified PDF file.
ExportToExcel(Dashboard, Stream, DashboardState, DashboardExcelExportOptions) Exports a dashboard’s data to the specified stream in Excel format.
ExportToExcel(Dashboard, String, DashboardState, DashboardExcelExportOptions) Exports a dashboard’s data to the specified Excel file.
ExportToExcel(Stream, Stream, DashboardState, DashboardExcelExportOptions) Exports a dashboard’s data to the specified stream in Excel format.
ExportToExcel(Stream, String, DashboardState, DashboardExcelExportOptions) Exports a dashboard’s data to the specified Excel file.
ExportToExcel(String, Stream, DashboardState, DashboardExcelExportOptions) Exports a dashboard’s data to the specified stream in Excel format.
ExportToExcel(String, String, DashboardState, DashboardExcelExportOptions) Exports a dashboard’s data to the specified Excel file.
ExportToImage(Dashboard, Stream, Nullable<Size>, DashboardState, DashboardImageExportOptions) Exports a dashboard’s data to the specified stream in Image format.
ExportToImage(Dashboard, String, Nullable<Size>, DashboardState, DashboardImageExportOptions) Exports a dashboard’s data to the specified Image file.
ExportToImage(Stream, Stream, Nullable<Size>, DashboardState, DashboardImageExportOptions) Exports a dashboard’s data to the specified stream in Image format.
ExportToImage(Stream, String, Nullable<Size>, DashboardState, DashboardImageExportOptions) Exports a dashboard’s data to the specified Image file.
ExportToImage(String, Stream, Nullable<Size>, DashboardState, DashboardImageExportOptions) Exports a dashboard’s data to the specified stream in Image format.
ExportToImage(String, String, Nullable<Size>, DashboardState, DashboardImageExportOptions) Exports a dashboard’s data to the specified Image file.
ExportToPdf(Dashboard, Stream, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Exports a dashboard’s data to the specified stream in PDF format.
ExportToPdf(Dashboard, String, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Exports a dashboard’s data to the specified PDF file.
ExportToPdf(Stream, Stream, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Exports a dashboard’s data to the specified stream in PDF format.
ExportToPdf(Stream, String, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Exports a dashboard’s data to the specified PDF file.
ExportToPdf(String, Stream, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Exports a dashboard’s data to the specified stream in PDF format.
ExportToPdf(String, String, Nullable<Size>, DashboardState, DashboardPdfExportOptions) Exports a dashboard’s data to the specified PDF file.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetPrintableControl(Dashboard, String) Gets a printable control corresponding to the specified dashboard item.
GetPrintableControl(Stream, String) Gets a printable control corresponding to the specified dashboard item.
GetPrintableControl(String, String) Gets a printable control corresponding to the specified dashboard item.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
BeforeExportDocument Allows you to hide specific dashboard items when you export the entire dashboard.
ConfigureDataConnection Allows you to customize connection settings before the connection to a data store (database, OLAP cube, etc.) is established.
ConfigureItemDataCalculation Allows you to configure how the dashboard item’s client data is calculated.
ConnectionError Allows you to detect an error when connection parameters do not allow you to connect to a data store.
CustomAssemblyLoading Occurs before a custom assembly is loaded for use as DashboardEFDataSource.
CustomExport Allows you to customize the exported document.
CustomFilterExpression Allows you to include WHERE clauses in DashboardSqlDataSource queries.
CustomItemExportControlCreating Occurs when the DashboardExporter component exports a custom item.
CustomizeExportDocument Allows you to customize the exported document.
CustomPalette Allows you to substitute the default palette that contains 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.
DashboardItemDataLoadingError Allows you to detect errors that occurred while a dashboard item loaded data.
DataLoading Allows you to provide data for the DashboardObjectDataSource.
DataLoadingError Allows you to detect errors that occurred while a dashboard loaded data.
ExcelDataSourceBeforeFill Allows you to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.
ValidateCustomSqlQuery Allows you to validate a custom SQL query of the DashboardSqlDataSource.
See Also