Class Report

The base class for a report.

System.Object
  Stonefield.Collections.BaseItem
    Stonefield.Collections.BaseNamedItem
      Stonefield.Collections.BaseNamedItemPersistent
        Stonefield.Query.ReportEngine.ReportBase
          Stonefield.Query.ReportEngine.Report
public abstract class Report : ReportBase, IReport

Class Members

MemberDescription

Constructor

Parameterless constructor required for the collection.

IDChanged

Raised when the ID is changed.

PropertyChanged

Raised when a property is changed.

AddField

Adds a field to the report.

public abstract IReportField AddField(IField field);

AddPermission

Adds a permission to this report.

public sealed void AddPermission(IPermission permission);

CanSave

Checks whether the user can save the report.

public sealed bool CanSave();

Clone

Clones the report.

public sealed IReport Clone();

Copy

Creates a copy of the report with a new ID.

public sealed IReport Copy();

public sealed IReport Copy(string name);

CreateDataOnlyLayout

Creates a data-only layout into ReportLayoutDataOnly.

public virtual ReportResult CreateDataOnlyLayout();

CreateLayout

Creates the full report layout into ReportLayout and a data-only layout into ReportLayoutDataOnly.

public virtual ReportResult CreateLayout();

public virtual ReportResult CreateLayout(bool subreport);

Email

Emails the report using the settings specified in ExportOptions.

public sealed ReportResult Email();

Export

Outputs the report to file using the settings specified in ExportOptions.

public sealed ReportResult Export();

public sealed ReportResult Export(Stream stream);

GetConditionValue

Returns the specified value for the specified condition.

public sealed string GetConditionValue(int conditionIndex,
    int valueIndex);

GetField

Finds the specified field in the report by name.

public sealed IReportField GetField(string name);

public sealed IReportField GetField(Guid id);

GetFields

Returns the field collection for the report cast as IReportField.

public abstract List<IReportField> GetFields();

GetFormulas

Returns a list of formulas used in fields.

public sealed List<ICalculatedField> GetFormulas();

Load

Loads the report from the specified XML file.

public sealed void Load(string fileName);

public sealed void Load(XmlDocument doc);

Print

Prints the report to the default printer.

public sealed ReportResult Print();

public sealed ReportResult Print(string printerName);

RemovePermission

Removes a permission from this report.

public sealed void RemovePermission(IPermission permission);

Save

Saves the report to the specified file.

public sealed void Save(string fileName);

public virtual void Save();

SaveToXML

Saves the report to an XmlDocument.

public XmlDocument SaveToXML();

SetDataGroup

Sets the data group for this report from the passed in data group ID.

public sealed void SetDataGroup(Guid dataGroupID);

ToString

Returns the name of the item.

public virtual string ToString();

UpdateDataRetrievalProgress

An event handler for a data retrieval update event The event fires after each batch of data is retrieved to see if the process should be cancelled. The report engine handles wiring this event to the data engine when called normally.

public sealed void UpdateDataRetrievalProgress(object sender,
    UpdateProgressEventArgs e);

UploadExport

Output the report and upload it to an FTP site.

public sealed ReportResult UploadExport(string server,     string username,     string password,     string folder)

AddDistinct

Determines whether the DISTINCT clause is added to the query for the report.

AfterData

Code to execute after retrieving the data for the report.

AfterRun

Code to execute after running the report.

AllowEmptyResultSet

True to allow a report to run when no records are returned.

Application

A reference to the application object.

AutofitToPage

True to scale down the size of a report until it fits the page dimensions.

Cancelled

Set this property to true to cancel the report run.

Changed

Flags that one or more properties of the item have changed since it was last loaded or saved.

Comments

The comments for the report.

CreatedAt

When the report was created.

CreatedBy

The user who created the report.

CustomJoins

A collection of custom joins for the report.

DataEngine

The DataEngine used to retrieve data for the report.

DataGroup

The data group for the report.

DataSource

The name of the data source(s) the report is running against.

DataSources

The names of data sources to run the report against. If the collection is empty, the report is run against the default data source only. Otherwise, the report includes records from all of the specified data sources.

DefaultFont

The default font for the report, which comes from the report's template.

DefaultTable

The default table for the report.

DisplayTitle

The title as displayed to the user.

EnableHyperlinks

True if hyperlinks are enabled when the report layout is created.

EvaluatorFactory

A reference to an evaluator factory.

ExcludeConditions

A collection of FilterCondition objects that make up the exclusion filter for the report.

ExclusionTable

The table used to link to the subquery for the exclusion filter for the report.

ExportOptions

Export options for the report.

FileName

The full path for the report file.

FilterConditions

A collection of FilterCondition objects that make up the filter for the report.

GenerateLayoutOnEachRun

True to generate the layout every time the report is run or false to only generate it the first time.

GroupFilterConditions

A collection of GroupFilterCondition objects that make up the group filter for the report.

HasHyperlinks

True if the report has any hyperlinks.

HasLayout

True if the report has an advanced layout.

ID

The ID of the item.

JoinStatement

The join statement used if SQLStatement contains more than one SQL statement.

Layout

The advanced layout for the report.

Loading

Flags that the item is being loaded from storage.

Localizable

True if the report is localized when it's run.

Margins

The margins for the report.

ModifiedAt

When the report was last modified.

ModifiedBy

The user who last modified the report.

Name

The name of the item.

NotAllFieldsVisibleToCurrentUser

True if not all fields in the report are visible to the current user.

Orientation

The orientation of the report.

Owner

The user who owns the report.

PaperKind

The kind of paper for the report.

PaperSize

The paper size (only used if PaperKind is set to Custom).

Parameters

Parameters to prompt the user for when running the report.

Permissions

A collection of Permission objects that define what roles have access to the report and what rights they have.

RenderOnPlatform

The platform the report is being run on.

ReportLayout

The report layout. This is normally cast to ReportLayout to access members.

ReportLayoutDataOnly

The report layout for data-only output. This is normally cast to ReportLayout to access members.

ResultSet

The result set for the report.

SQLStatements

The custom SQL statements for the report.

Tags

A collection of tags for the report.

Template

The template for the report.

Tenant

The tenant the user belongs to.

Title

The report title.

TopOptions

The settings for the TOP clause for the report.

UserName

The name of the user creating, editing, or running the report.

Requirements

Namespace: Stonefield.Query.ReportEngine
Assembly: reports.dll