Class Report - Stonefield Query SDK

Class Report

A Stonefield Query Report.

System.Object
SFQWrapper.SQBase
SFQWrapper.Report

public class Report : SQBase

Class Members

Member		Description
	CreateOutput	Outputs the report to a file or email. Note that the report must have already be run. Before creating a file, call SetOutputToFile to set the file specifications. Before sending an email, set the Recipients, BCCRecipients, CCRecipients, EmailSubject, and EmailBody properties. public bool CreateOutput(bool Email);
	GetAskAtRuntimeFilter	Return a specific Ask-At-Runtime filter. Passing 0 returns the first Ask-At-Runtime filter, 1 returns the second and so on. public FilterCondition GetAskAtRuntimeFilter(int item);
	GetAskAtRuntimeFilterCount	Returns the number of Ask at Runtime filters that are on this report. public int GetAskAtRuntimeFilterCount();
	GetReportFilter	Returns the descriptive filter expression for the report. public string GetReportFilter();
	GetReportFooter	Returns the evaluated footer expression. public string GetReportFooter();
	GetReportHeader	Returns the evaluated header expression. public string GetReportHeader();
	RunReport	Runs the report. public bool RunReport();
	SetOutputToFile	Sets the output properties of the report based on the parameters passed. Call this before calling CreateOutput(). public bool SetOutputToFile(string FileName, string Type, string SubType); public bool SetOutputToFile(string FileName, string Type); public bool SetOutputToFile(string FileName);
	Advanced	True if the report uses an advanced layout.
	AllowDuplicates	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	True if the Run report with no records option is turned on.
	AllowFilter	True if the Allow report to be filtered option is turned on.
	AllowSort	True if the Allow report to be sorted option is turned on.
	AskAtRunTime	True if the report has any ask-at-runtime filter conditions, False if not.
	BCCRecipients	The blind carbon copy (BCC) email addresses (separated by commas) to send an emailed report to.
	CCRecipients	The carbon copy (CC) email addresses (separated by commas) to send an emailed report to.
	Comments	The report comments.
	CustomJoins	The CustomJoins collection containing the custom joins for the report.
	DataGroup	The data group for the report.
	DisplayFilter	True if the "Include filter in report header" option is turned on.
	Distinct	True if the "Add DISTINCT to SQL statement" option is set to Yes.
	EmailBody	The message body for the email.
	EmailSubject	The subject for the email.
	EncodedName	An HTML-encoded version of the report name.
	EndPage	The value the user entered for the End page option.
	EraseFile	True to erase the file after the email is sent.
	ErrorMessage	The message for any error that occurred.
	ExcludeConditions	A reference to a FilterConditions collection containing the exclude filter conditions for the report.
	Fields	A reference to the ReportFields collection containing the field items for the report.
	FilterConditions	A reference to a FilterConditions collection containing the filter conditions for the report.
	Footer	The unevaluated footer expression.
	ForEachMode	True if the Output each group as a separate file option is turned on.
	HaveGroupedFields	True if there are any grouped fields in the report.
	Header	The unevaluated header expression.
	ID	The report ID.
	Margin	The value the user entered for the Left margin option.
	Orientation	The orientation: 0 means automatic, 1 means portrait, and 2 means landscape.
	Output	The type of output for the report: "FILE," "PRINTER," "PREVIEW," "EMAIL," or "NONE".
	OutputFileName	The name of the file to output to.
	Recipients	The email addresses (separated by commas) to send an email to.
	Records	The number of records in the result set for the report.
	ReportName	The report name.
	ReportType	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, "G" for a gauge, "E" for an external report, or "Y" for a Crystal report.
	ShowTotalsInGroupHeader	True if the Show totals in group headers option is turned on.
	Sorts	A reference to the Sort collection for the report.
	SQLSelect	The custom SQL statement for the report.
	StartPage	The value the user entered for the Start page option.
	Summary	True if the Summary report option is turned on.
	Template	The template for the report (not applicable to labels).
	Timestamp	True if the Add timestamp to file name option is turned on.
	UserName	The name of the user who created the report.

Requirements

Namespace: SFQWrapper
Assembly: sfqwrapper.dll