Interface IDashboardExporter

Namespace: Reveal.Sdk

Assembly: Infragistics.Reveal.SDK.Server.dll

Syntax

public interface IDashboardExporter

Methods

Export(ExportFormat, String)

Exports a dashboard to a specific format

Declaration

Task<Stream> Export(ExportFormat format, string dashboardId)

Parameters

Type	Name	Description
ExportFormat	format	ExportFormat indicating the output format
System.String	dashboardId	Dashboard identifier

Returns

Type	Description
System.Threading.Tasks.Task<System.IO.Stream>	Stream containing the output file

Export(ExportFormat, String, IExportOptions, IRVUserContext)

Exports a dashboard to a specific format

Declaration

Task<Stream> Export(ExportFormat format, string dashboardId, IExportOptions options = null, IRVUserContext userContext = null)

Parameters

Type	Name	Description
ExportFormat	format	ExportFormat indicating the output format
System.String	dashboardId	Dashboard identifier
IExportOptions	options	IExportOptions
IRVUserContext	userContext	User context

Returns

Type	Description
System.Threading.Tasks.Task<System.IO.Stream>	Stream containing the output file

Export(ExportFormat, String, String)

Exports a dashboard to a specific format

Declaration

Task Export(ExportFormat format, string dashboardId, string filePath)

Parameters

Type	Name	Description
ExportFormat	format	ExportFormat indicating the output format
System.String	dashboardId	Dashboard identifier
System.String	filePath	Destination file for the exported dashboard

Returns

Type	Description
System.Threading.Tasks.Task

Export(ExportFormat, String, String, IExportOptions, IRVUserContext)

Exports a dashboard to a specific format

Declaration

Task Export(ExportFormat format, string dashboardId, string filePath, IExportOptions options = null, IRVUserContext userContext = null)

Parameters

Type	Name	Description
ExportFormat	format	ExportFormat indicating the output format
System.String	dashboardId	Dashboard identifier
System.String	filePath
IExportOptions	options	IExportOptions
IRVUserContext	userContext	User context

Returns

Type	Description
System.Threading.Tasks.Task

Extension Methods

IDashboardExporterExtensions.ExportToPdf(IDashboardExporter, String)

IDashboardExporterExtensions.ExportToPdf(IDashboardExporter, String, PdfExportOptions, IRVUserContext)

IDashboardExporterExtensions.ExportToPdf(IDashboardExporter, String, String)

IDashboardExporterExtensions.ExportToPdf(IDashboardExporter, String, String, PdfExportOptions, IRVUserContext)

IDashboardExporterExtensions.ExportToExcel(IDashboardExporter, String)

IDashboardExporterExtensions.ExportToExcel(IDashboardExporter, String, ExcelExportOptions, IRVUserContext)

IDashboardExporterExtensions.ExportToExcel(IDashboardExporter, String, String)

IDashboardExporterExtensions.ExportToExcel(IDashboardExporter, String, String, ExcelExportOptions, IRVUserContext)

IDashboardExporterExtensions.ExportToPowerPoint(IDashboardExporter, String)

IDashboardExporterExtensions.ExportToPowerPoint(IDashboardExporter, String, PowerPointExportOptions, IRVUserContext)

IDashboardExporterExtensions.ExportToPowerPoint(IDashboardExporter, String, String)

IDashboardExporterExtensions.ExportToPowerPoint(IDashboardExporter, String, String, PowerPointExportOptions, IRVUserContext)