Class ReportBuilder

Class ReportBuilder

Namespace: Aspose.Words.LowCode
Assembly: Aspose.Words.dll (25.2.0)

Provides methods intended to fill template with data using LINQ Reporting Engine.

public static class ReportBuilder

Inheritance

objectReportBuilder

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Methods

BuildReport(string, string, object)

Populates the template document with data from the specified source, generating a completed report.

public static void BuildReport(string inputFileName, string outputFileName, object data)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

data object

A data source object.

BuildReport(string, string, object, ReportBuilderOptions)

Populates the template document with data from the specified source, generating a completed report with additional options.

public static void BuildReport(string inputFileName, string outputFileName, object data, ReportBuilderOptions reportBuilderOptions)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

data object

A data source object.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(string, string, SaveFormat, object)

Populates the template document with data from the specified source, generating a completed report with specified output format.

public static void BuildReport(string inputFileName, string outputFileName, SaveFormat saveFormat, object data)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveFormat SaveFormat

The output’s save format.

data object

A data source object.

BuildReport(string, string, SaveFormat, object, ReportBuilderOptions)

Populates the template document with data from the specified source, generating a completed report with specified output format and additional options.

public static void BuildReport(string inputFileName, string outputFileName, SaveFormat saveFormat, object data, ReportBuilderOptions reportBuilderOptions)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveFormat SaveFormat

The output’s save format.

data object

A data source object.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(string, string, SaveOptions, object, ReportBuilderOptions)

Populates the template document with data from the specified source, generating a completed report with specified output format and additional options.

public static void BuildReport(string inputFileName, string outputFileName, SaveOptions saveOptions, object data, ReportBuilderOptions reportBuilderOptions)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveOptions SaveOptions

The output’s save options.

data object

A data source object.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(Stream, Stream, SaveFormat, object)

Populates the template document with data from the specified source, generating a completed report from input and output streams.

public static void BuildReport(Stream inputStream, Stream outputStream, SaveFormat saveFormat, object data)

Parameters

inputStream Stream

The input file stream.

outputStream Stream

The output file stream.

saveFormat SaveFormat

The output’s save format.

data object

A data source object.

BuildReport(Stream, Stream, SaveFormat, object, ReportBuilderOptions)

Populates the template document with data from the specified source, generating a completed report with specified output format and additional options, from input and output streams.

public static void BuildReport(Stream inputStream, Stream outputStream, SaveFormat saveFormat, object data, ReportBuilderOptions reportBuilderOptions)

Parameters

inputStream Stream

The input file stream.

outputStream Stream

The output file stream.

saveFormat SaveFormat

The output’s save format.

data object

A data source object.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(Stream, Stream, SaveOptions, object, ReportBuilderOptions)

Populates the template document with data from the specified source, generating a completed report with specified output format and additional options, from input and output streams.

public static void BuildReport(Stream inputStream, Stream outputStream, SaveOptions saveOptions, object data, ReportBuilderOptions reportBuilderOptions)

Parameters

inputStream Stream

The input file stream.

outputStream Stream

The output file stream.

saveOptions SaveOptions

The output’s save options.

data object

A data source object.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(string, string, object, string)

Populates the template document with data from the specified source, generating a completed report with a named data source reference.

public static void BuildReport(string inputFileName, string outputFileName, object data, string dataSourceName)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

data object

A data source object.

dataSourceName string

A name to reference the data source object in the template.

BuildReport(string, string, object, string, ReportBuilderOptions)

Populates the template document with data from the specified source, generating a completed report with a named data source reference and additional options.

public static void BuildReport(string inputFileName, string outputFileName, object data, string dataSourceName, ReportBuilderOptions reportBuilderOptions)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

data object

A data source object.

dataSourceName string

A name to reference the data source object in the template.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(string, string, SaveFormat, object, string)

Populates the template document with data from the specified source, generating a completed report with specified output format and a named data source reference.

public static void BuildReport(string inputFileName, string outputFileName, SaveFormat saveFormat, object data, string dataSourceName)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveFormat SaveFormat

The output’s save format.

data object

A data source object.

dataSourceName string

A name to reference the data source object in the template.

BuildReport(string, string, SaveFormat, object, string, ReportBuilderOptions)

Populates the template document with data from the specified source, generating a completed report with specified output format, a named data source reference, and additional options.

public static void BuildReport(string inputFileName, string outputFileName, SaveFormat saveFormat, object data, string dataSourceName, ReportBuilderOptions reportBuilderOptions)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveFormat SaveFormat

The output’s save format.

data object

A data source object.

dataSourceName string

A name to reference the data source object in the template.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(string, string, SaveOptions, object, string, ReportBuilderOptions)

Populates the template document with data from the specified source, generating a completed report with specified output format, a named data source reference, and additional options.

public static void BuildReport(string inputFileName, string outputFileName, SaveOptions saveOptions, object data, string dataSourceName, ReportBuilderOptions reportBuilderOptions)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveOptions SaveOptions

The output’s save options.

data object

A data source object.

dataSourceName string

A name to reference the data source object in the template.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(Stream, Stream, SaveFormat, object, string)

Populates the template document with data from the specified source, generating a completed report with a named data source reference.

public static void BuildReport(Stream inputStream, Stream outputStream, SaveFormat saveFormat, object data, string dataSourceName)

Parameters

inputStream Stream

The input file stream.

outputStream Stream

The output file stream.

saveFormat SaveFormat

The output’s save format.

data object

A data source object.

dataSourceName string

A name to reference the data source object in the template.

BuildReport(Stream, Stream, SaveFormat, object, string, ReportBuilderOptions)

Populates the template document with data from the specified source, generating a completed report with a named data source reference and additional options.

public static void BuildReport(Stream inputStream, Stream outputStream, SaveFormat saveFormat, object data, string dataSourceName, ReportBuilderOptions reportBuilderOptions)

Parameters

inputStream Stream

The input file stream.

outputStream Stream

The output file stream.

saveFormat SaveFormat

The output’s save format.

data object

A data source object.

dataSourceName string

A name to reference the data source object in the template.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(Stream, Stream, SaveOptions, object, string, ReportBuilderOptions)

Populates the template document with data from the specified source, generating a completed report with a named data source reference and additional options.

public static void BuildReport(Stream inputStream, Stream outputStream, SaveOptions saveOptions, object data, string dataSourceName, ReportBuilderOptions reportBuilderOptions)

Parameters

inputStream Stream

The input file stream.

outputStream Stream

The output file stream.

saveOptions SaveOptions

The output’s save options.

data object

A data source object.

dataSourceName string

A name to reference the data source object in the template.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(string, string, object[], string[])

Populates the template document with data from multiple sources, generating a completed report from the specified input and output file names. This overload automatically determines the save format based on the output file extension.

public static void BuildReport(string inputFileName, string outputFileName, object[] data, string[] dataSourceNames)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

data object[]

An array of data source objects.

dataSourceNames string[]

An array of names to reference the data source objects within the template.

BuildReport(string, string, object[], string[], ReportBuilderOptions)

Populates the template document with data from multiple sources, generating a completed report with additional options. This overload automatically determines the save format based on the output file extension.

public static void BuildReport(string inputFileName, string outputFileName, object[] data, string[] dataSourceNames, ReportBuilderOptions reportBuilderOptions)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

data object[]

An array of data source objects.

dataSourceNames string[]

An array of names to reference the data source objects within the template.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(string, string, SaveFormat, object[], string[])

Populates the template document with data from multiple sources, generating a completed report with a specified output format. This overload automatically determines the save format based on the output file extension.

public static void BuildReport(string inputFileName, string outputFileName, SaveFormat saveFormat, object[] data, string[] dataSourceNames)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveFormat SaveFormat

The output’s save format.

data object[]

An array of data source objects.

dataSourceNames string[]

An array of names to reference the data source objects within the template.

BuildReport(string, string, SaveFormat, object[], string[], ReportBuilderOptions)

Populates the template document with data from multiple sources, generating a completed report with a specified output format and additional options.

public static void BuildReport(string inputFileName, string outputFileName, SaveFormat saveFormat, object[] data, string[] dataSourceNames, ReportBuilderOptions reportBuilderOptions)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveFormat SaveFormat

The output’s save format.

data object[]

An array of data source objects.

dataSourceNames string[]

An array of names to reference the data source objects within the template.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(string, string, SaveOptions, object[], string[], ReportBuilderOptions)

Populates the template document with data from multiple sources, generating a completed report with a specified output format and additional options.

public static void BuildReport(string inputFileName, string outputFileName, SaveOptions saveOptions, object[] data, string[] dataSourceNames, ReportBuilderOptions reportBuilderOptions)

Parameters

inputFileName string

The input file name.

outputFileName string

The output file name.

saveOptions SaveOptions

The output’s save options.

data object[]

An array of data source objects.

dataSourceNames string[]

An array of names to reference the data source objects within the template.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(Stream, Stream, SaveFormat, object[], string[])

Populates the template document with data from multiple sources, generating a completed report from the specified input and output file streams.

public static void BuildReport(Stream inputStream, Stream outputStream, SaveFormat saveFormat, object[] data, string[] dataSourceNames)

Parameters

inputStream Stream

The input file stream.

outputStream Stream

The output file stream.

saveFormat SaveFormat

The output’s save format.

data object[]

An array of data source objects.

dataSourceNames string[]

An array of names to reference the data source objects within the template.

BuildReport(Stream, Stream, SaveFormat, object[], string[], ReportBuilderOptions)

Populates the template document with data from multiple sources, generating a completed report with specified output format and additional options from the specified input and output file streams.

public static void BuildReport(Stream inputStream, Stream outputStream, SaveFormat saveFormat, object[] data, string[] dataSourceNames, ReportBuilderOptions reportBuilderOptions)

Parameters

inputStream Stream

The input file stream.

outputStream Stream

The output file stream.

saveFormat SaveFormat

The output’s save format.

data object[]

An array of data source objects.

dataSourceNames string[]

An array of names to reference the data source objects within the template.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

BuildReport(Stream, Stream, SaveOptions, object[], string[], ReportBuilderOptions)

Populates the template document with data from multiple sources, generating a completed report with specified output format and additional options from the specified input and output file streams.

public static void BuildReport(Stream inputStream, Stream outputStream, SaveOptions saveOptions, object[] data, string[] dataSourceNames, ReportBuilderOptions reportBuilderOptions)

Parameters

inputStream Stream

The input file stream.

outputStream Stream

The output file stream.

saveOptions SaveOptions

The output’s save options.

data object[]

An array of data source objects.

dataSourceNames string[]

An array of names to reference the data source objects within the template.

reportBuilderOptions ReportBuilderOptions

Additional report build options.

 English