Class ReportBuilder
Namespace: Aspose.Words.LowCode
Assembly: Aspose.Words.dll (25.4.0)
Provides methods intended to fill template with data using LINQ Reporting Engine.
public class ReportBuilder : ProcessorInheritance
object ← Processor ← ReportBuilder
Inherited Members
Processor.mResultDocument , Processor.From(string, LoadOptions) , Processor.From(Stream, LoadOptions) , Processor.To(string, SaveOptions) , Processor.To(string, SaveFormat) , Processor.To(Stream, SaveOptions) , Processor.To(Stream, SaveFormat) , Processor.To(List<stream>, SaveOptions) , Processor.To(List<stream>, SaveFormat) , Processor.Execute() , Processor.ExecuteCore() , Processor.CheckArgumentsSet() , Processor.GetPartFileName(string, int, SaveFormat) , object.GetType() , object.MemberwiseClone() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()
Methods
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), only the first page of the output will be saved to the specified stream.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF to the specified stream.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), only the first page of the output will be saved to the specified stream.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF to the specified stream.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), only the first page of the output will be saved to the specified stream.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF to the specified stream.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), only the first page of the output will be saved to the specified stream.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF to the specified stream.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), only the first page of the output will be saved to the specified stream.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF to the specified stream.
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 = null)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.
Remarks
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), only the first page of the output will be saved to the specified stream.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF to the specified stream.
BuildReportToImages(string, ImageSaveOptions, object[], string[], ReportBuilderOptions)
Populates the template document with data from multiple sources. Renders the output to images.
public static Stream[] BuildReportToImages(string inputFileName, ImageSaveOptions saveOptions, object[] data, string[] dataSourceNames, ReportBuilderOptions reportBuilderOptions = null)Parameters
inputFileName string
The input file name.
saveOptions ImageSaveOptions
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.
Returns
Stream []
BuildReportToImages(Stream, ImageSaveOptions, object[], string[], ReportBuilderOptions)
Populates the template document with data from multiple sources. Renders the output to images.
public static Stream[] BuildReportToImages(Stream inputStream, ImageSaveOptions saveOptions, object[] data, string[] dataSourceNames, ReportBuilderOptions reportBuilderOptions = null)Parameters
inputStream Stream
The input file stream.
saveOptions ImageSaveOptions
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.
Returns
Stream []
Create()
Creates new instance of the report builder processor.
public static ReportBuilder Create()Returns
Create(ReportBuilderContext)
Creates new instance of the report builder processor.
public static ReportBuilder Create(ReportBuilderContext context)Parameters
context ReportBuilderContext
Returns
ExecuteCore()
protected override void ExecuteCore()</stream></stream>
