Interface IReportInstance<TTemplate>

Provides methods for an instance of an IReportTemplate.

Namespace: Sartorius.SAF.ReportGenerator
Assembly: Sartorius.SAF.ReportGenerator.dll
Syntax
public interface IReportInstance<out TTemplate> : IReportData where TTemplate : IReportTemplate
Type Parameters
Name Description
TTemplate

Properties

View Source

Template

Gets the template this report instance was created from.

Declaration
TTemplate Template { get; }
Property Value
Type Description
TTemplate

Methods

View Source

CreateHtmlReportAsync(CultureInfo[])

Creates an HTML document according to the current state of the template.

Declaration
Task<Stream> CreateHtmlReportAsync(params CultureInfo[] cultures)
Parameters
Type Name Description
System.Globalization.CultureInfo[] cultures

The cultures to use for the report.
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

A System.Threading.Tasks.Task representing the asynchronous operation. The System.Threading.Tasks.Task`1.Result property on the task object returns a System.IO.Stream containing the document data. This will be html.
View Source

CreateReportAsync(ReportOutputOptions, CultureInfo[])

Creates a document according to the current state of the template.

Declaration
Task<Stream> CreateReportAsync(ReportOutputOptions options, params CultureInfo[] cultures)
Parameters
Type Name Description
ReportOutputOptions options

The output options for the report.
System.Globalization.CultureInfo[] cultures

The cultures to use for the report.
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

A System.Threading.Tasks.Task representing the asynchronous operation. The System.Threading.Tasks.Task`1.Result property on the task object returns a System.IO.Stream containing the document data. This will generally be a pdf.
View Source

CreateReportAsync(CultureInfo[])

Creates a document according to the current state of the template and default output options.

Declaration
Task<Stream> CreateReportAsync(params CultureInfo[] cultures)
Parameters
Type Name Description
System.Globalization.CultureInfo[] cultures

The cultures to use for the report.
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

A System.Threading.Tasks.Task representing the asynchronous operation. The System.Threading.Tasks.Task`1.Result property on the task object returns a System.IO.Stream containing the document data. This will generally be a pdf.
View Source

CreateXmlReportAsync(CultureInfo[])

Creates an Xml document according to the current state of the template.

Declaration
Task<Stream> CreateXmlReportAsync(params CultureInfo[] cultures)
Parameters
Type Name Description
System.Globalization.CultureInfo[] cultures

The cultures to use for the report.
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

A System.Threading.Tasks.Task representing the asynchronous operation. The System.Threading.Tasks.Task`1.Result property on the task object returns a System.IO.Stream containing the document data. This will be a xml.

Extension Methods