ReportEngine.RunReportToFile

Runs the specified report, outputting it to the specified file.

public bool RunReportToFile(string ReportName,
	string OutputFileName,
	string FileType,
	string FileSubType,
	string Values);

Return Value

True if the report ran successfully and the file was created or False if an error occurred or no records match the filter condition (in that case, check the ErrorMessage property of the ReportEngine object for the reason for failure).

Parameters

ReportName
The name of the report to run.

OutputFileName
The name and path of the file to output the report to. If the file already exists, it's overwritten.

FileType
The type of file to create. This is the same as a file extension: "PDF" for a PDF file, "XLS" for a Microsoft Excel file, "DOC" for a Microsoft Word file, "HTML" for an HTML file, and so forth (see the Output Options topic in the Stonefield Query help file for a list of the file types supported).

FileSubType
Since Stonefield Query can output either data-only or full format for Microsoft Excel, specify the type of file you want if you output to Excel: either "full" for full format or "data" for data-only.

Values
The values for any ask-at-runtime conditions. If it is passed, this parameter must be specified as an XML string with the following format: First valueSecond value

        Put no space between the opening and closing "value" tags to indicate that a condition should be ignored. For example:

Overloads:


See also:

Class ReportEngine
© Stonefield Software Inc., 2024 • Updated: 06/06/16
Comment or report problem with topic