BI Dashboard - Non-Visual Custom Export

This example shows how to use the DashboardExporter component in a console application to export a dashboard with a custom Funnel item.

How to Use the Application

In the console, run the DashboardExporterApp.exe application and specify the path where you want to export the document:

D:\work\test\app>DashboardExporterApp.exe D:/work/test

The application generates a PDF file from the Dashboard.xml dashboard located in the Dashboards folder next to the DashboardExporterApp.exe application:

Example Overview

The following files are used in this example:

FunnelItemExportControlProvider

View file: CS/VB

The FunnelItemExportControlProvider class implements the ICustomExportControlProvider interface. The FunnelItemExportControlProvider is used to configure the printable control for the custom Funnel item in the dashboard.

The ICustomExportControlProvider.GetPrintableControl method specifies the printable XRChart control that is used to export the custom Funnel. The method gets CustomItemExportInfo and CustomItemData objects as parameters.

The CustomItemExportInfo object contains the custom Funnel's export settings as the ExportMode and master filter state.

The ChartControl.SelectionMode property is updated according to the actual master filter mode. The SetSelection method updates the custom control according to the current master filter selection.

The ConigureSeries method is used to bind the custom Funnel chart's series to data and configure them. The CustomItemData.GetBindings method gets a CustomItemBindingValue collection. Each object in this collection contains information about data items stored in a custom item. The object’s UniqueId property value can be used as a data member when a custom control is bounded to data.

Program

View file: CS/VB

The CustomItemExportControlCreating event fires for the Funnel item. The FunnelItemExportControlProvider object is assigned to and the ExportControlProvider property. The property is used to specify the printable control that corresponds to the exported custom Funnel item.

The DashboardExporter.ExportToPdf method exports a dashboard as a PDF file.

Files to Review

• FunnelItemExportControlProvider.cs (VB: FunnelItemExportControlProvider.vb)
• Program.cs (VB: Program.vb)

Documentation

• Create an Interactive Data-Aware Item for the WinForms Dashboard
• ICustomExportControlProvider
• DashboardExporter
• CustomItemExportControlCreating

More examples

• BI Dashboard - Non-Visual Export Component
• BI Dashboard - How to Email a Dashboard that Displays Different Data Depending on the Addressee
• BI Dashboard - How to Use MailKit to Send a Dashboard as a Document in PDF