Report Object

A Report object contains the properties for a report. This object is returned by the GetReport method of the ReportEngine object.

Properties

Name Data Type Description

Advanced Boolean True if the report uses an advanced layout.

AllowDuplicates Boolean True if the Add DISTINCT to SQL statement option is set to something other than "When filtering on a table not included in the fields list."

AllowEmptyResultSet Boolean True if the Run report with no records option is turned on.

AllowFilter Boolean True if the Allow report to be filtered option is turned on.

AllowSort Boolean True if the Allow report to be sorted option is turned on.

AskAtRunTime Boolean True if the report has any ask-at-runtime filter conditions, False if not.

BCCRecipients String The blind carbon copy (BCC) email addresses (separated by commas) to send an emailed report to.

CCRecipients String The carbon copy (CC) email addresses (separated by commas) to send an emailed report to.

Comments String The report comments.

CustomJoins Object A reference to the CustomJoins collection for the report.

DataGroup String The data group for the report.

DisplayFilter Boolean True if the Include filter in report header option is turned on.

Distinct Boolean True if the Add DISTINCT to SQL statement option is set to Yes.

EmailBody String The message body for the email.

EmailSubject String The subject for the email.

EncodedName String An HTML-encoded version of the report name.

EndPage Integer The value the user entered for the End page option.

EraseFile Integer True to erase the file after the email is sent.

ErrorMessage String The text of any error that occurred.

ExcludeConditions Object A reference to a FilterConditions collection containing the exclude filter conditions for the report.

Fields Object A reference to the ReportFields collection containing the field items for the report.

FilterConditions Object A reference to a FilterConditions collection containing the filter conditions for the report.

Footer String The unevaluated footer expression.

ForEachMode Boolean True if the Output each group as a separate file option is turned on.

HaveGroupedFields Boolean True if there are any grouped fields in the report.

Header String The unevaluated header expression.

ID Integer The report ID.

Margin Integer The value the user entered for the Left margin option.

Orientation Integer The orientation: 0 means automatic, 1 means portrait, and 2 means landscape.

Output String The type of output for the report: "PREVIEW," "PRINTER," "FILE," or "EMAIL."

OutputFileName String The name of the file to output to.

Recipients String The email addresses (separated by commas) to send an email to.

Records Integer The number of records in the result set for the report.

ReportName String The report name.

ReportType String The report type: "Q" for a quick report, "X" for a cross-tab report, "L" for a label, "C" for a chart, "D" for a dashboard, "B" for a batch report, "E" for an external report, or "Y" for a Crystal report.

ShowTotalsInGroupHeader Boolean True if the Show totals in group header option is turned on.

Snapshot String The snapshot of the last time the report was run (returned as the bytes of the image).

Sorts Object A reference to the Sorts collection for the report.

SQLSelect String The custom SQL statement for the report.

StartPage Integer The value the user entered for the Start page option.

Summary Boolean True if the Summary report option is turned on.

Template String The template for the report (not applicable to labels).

Timestamp Boolean True if the Add timestamp to file name option is turned on.

UserName String The name of the user who created the report.

Name	Data Type	Description
Advanced	Boolean	True if the report uses an advanced layout.
AllowDuplicates	Boolean	True if the Add DISTINCT to SQL statement option is set to something other than "When filtering on a table not included in the fields list."
AllowEmptyResultSet	Boolean	True if the Run report with no records option is turned on.
AllowFilter	Boolean	True if the Allow report to be filtered option is turned on.
AllowSort	Boolean	True if the Allow report to be sorted option is turned on.
AskAtRunTime	Boolean	True if the report has any ask-at-runtime filter conditions, False if not.
BCCRecipients	String	The blind carbon copy (BCC) email addresses (separated by commas) to send an emailed report to.
CCRecipients	String	The carbon copy (CC) email addresses (separated by commas) to send an emailed report to.
Comments	String	The report comments.
CustomJoins	Object	A reference to the CustomJoins collection for the report.
DataGroup	String	The data group for the report.
DisplayFilter	Boolean	True if the Include filter in report header option is turned on.
Distinct	Boolean	True if the Add DISTINCT to SQL statement option is set to Yes.
EmailBody	String	The message body for the email.
EmailSubject	String	The subject for the email.
EncodedName	String	An HTML-encoded version of the report name.
EndPage	Integer	The value the user entered for the End page option.
EraseFile	Integer	True to erase the file after the email is sent.
ErrorMessage	String	The text of any error that occurred.
ExcludeConditions	Object	A reference to a FilterConditions collection containing the exclude filter conditions for the report.
Fields	Object	A reference to the ReportFields collection containing the field items for the report.
FilterConditions	Object	A reference to a FilterConditions collection containing the filter conditions for the report.
Footer	String	The unevaluated footer expression.
ForEachMode	Boolean	True if the Output each group as a separate file option is turned on.
HaveGroupedFields	Boolean	True if there are any grouped fields in the report.
Header	String	The unevaluated header expression.
ID	Integer	The report ID.
Margin	Integer	The value the user entered for the Left margin option.
Orientation	Integer	The orientation: 0 means automatic, 1 means portrait, and 2 means landscape.
Output	String	The type of output for the report: "PREVIEW," "PRINTER," "FILE," or "EMAIL."
OutputFileName	String	The name of the file to output to.
Recipients	String	The email addresses (separated by commas) to send an email to.
Records	Integer	The number of records in the result set for the report.
ReportName	String	The report name.
ReportType	String	The report type: "Q" for a quick report, "X" for a cross-tab report, "L" for a label, "C" for a chart, "D" for a dashboard, "B" for a batch report, "E" for an external report, or "Y" for a Crystal report.
ShowTotalsInGroupHeader	Boolean	True if the Show totals in group header option is turned on.
Snapshot	String	The snapshot of the last time the report was run (returned as the bytes of the image).
Sorts	Object	A reference to the Sorts collection for the report.
SQLSelect	String	The custom SQL statement for the report.
StartPage	Integer	The value the user entered for the Start page option.
Summary	Boolean	True if the Summary report option is turned on.
Template	String	The template for the report (not applicable to labels).
Timestamp	Boolean	True if the Add timestamp to file name option is turned on.
UserName	String	The name of the user who created the report.

Methods

Name Description

CreateOutput Outputs the report to a file or email.

GetReportFilter Returns the descriptive filter expression for the report.

GetReportFooter Returns the evaluated footer expression.

GetReportHeader Returns the evaluated header expression.

RunReport Runs the report.

SetOutputToFile Sets the output properties of the report based on the parameters passed

Name	Description
CreateOutput	Outputs the report to a file or email.
GetReportFilter	Returns the descriptive filter expression for the report.
GetReportFooter	Returns the evaluated footer expression.
GetReportHeader	Returns the evaluated header expression.
RunReport	Runs the report.
SetOutputToFile	Sets the output properties of the report based on the parameters passed