ReportEngine.RunReport

Runs the specified report, outputting it to the specified file type, and returns the file as a string.

public string RunReport(string ReportName,
	string FileType,
	string FileSubType,
	string Values);

Return Value

A string containing the output of the report or an empty string if the report run failed because of an error or no records matching 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.

<>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 or spreadsheets with an XLS extension, specify the type of file you want if you output to XLS: either "full" for full formatted Excel, "data" for data-only Excel, or "spreadsheet" for a spreadsheet XLS file.

<>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., 2023 • Updated: 06/01/10
Comment or report problem with topic