XLReport Methods

AboutBox

Opens the About dialog box.

Edit

Opens the template supplied in the Template property.

If the Template property contains an empty string, Active XL Report launches Excel with a new workbook open. Example:

See also: XLReport.Template property.

Report

Creates a report based on the template specified in the XLReport.Template property. Allows supplying all or any number of datasources with datasets.

The Datasets optional parameter contains an array of Variants. Each item in the array must be a dataset corresponding to the appropriate item of the XLRDatasources collection: the first item in the array (or the only parameter of the method) corresponds to the first datasource (of index 0) in the XLRDatasources collection; the second item corresponds to the second datasource (of index 1), and so on. Some (but not all) items can be omitted. In this case, you should supply corresponding datasources with datasets using the XLRDatasource.Dataset property. In order to supply the first or the only datasource with dataset, the Datasets parameter can be a dataset itself (i.e. not necessary an array of datasets). Examples:

To save the report workbook under new name use the XLReport.ReportBookName property.

See also: XLRDatasource.Dataset property, XLReport.Template property, XLReport.ReportBookName property, XLReport.ReportTo method, XLReport.Report2 method.

ReportTo

Creates a report based on the template specified in the XLReport.Template property. Allows supplying all or any number of datasources with datasets. Adds report worksheet(s) to a given workbook.

The Datasets optional parameter contains an array of Variants. Each item in the array must be a dataset corresponding to the appropriate item of the XLRDatasources collection: the first item in the array (or the only parameter of the method) corresponds to the first datasource (of index 0) in the XLRDatasources collection; the second item corresponds to the second datasource (of index 1), and so on. Some (but not all) items can be omitted. In this case, you should supply corresponding datasources with datasets using the XLRDatasource.Dataset property. In order to supply the first or the only datasource with dataset, the Datasets can be a dataset itself (i.e. not necessary an array of datasets).

To save the report workbook under new name use the XLReport.ReportBookName property.

See also: XLRDatasource.Dataset property, XLReport.Template property, XLReport.ReportBookName property, XLReport.Report method, XLReport.Report2 method.

Report2

Creates a report based on the template specified in the XLReport.Template property. Allows supplying all or any number of datasources with datasets.

All the parameters are optional. The Workbook parameter can accept a string containing the path and file name of a workbook, where the report worksheets should be added to. Besides, you can pass an object variable referencing a previously opened workbook in this parameter. The Datasets is described in the XLReport.Report method. If you work with several instances of Excel, specify the instance you need in the ExcelApp parameter.

To save the report workbook under new name use the XLReport.ReportBookName property.

Samples. In all the samples it is assumed that when the Report2 methodis called, the datasets are already assigned.

Generate a report.

Add a report to an existing workbook.

Add a report to the previously opened workbook.

See also: XLRDatasource.Dataset property, XLReport.Template property, XLReport.ReportBookName property, XLReport.Report method, XLReport.ReportTo method.