ReportObjectFactory Class

A Report is normally loaded via API in order to launch directly into the execution or editing of the report. In most cases, report loading is handled by the Exago runtime via the LoadFromRepository call. LoadFromRepository returns an object of type ReportObject.

In order for the load to complete, a corresponding SaveToApi is done. SaveToApi will save the ReportObject, including any modifications back to the API for loading (for execution or editing). Both LoadFromRepository and SaveToApi should be accessed via the Api.ReportObjectFactory property.

Both LoadFromRepository and SaveToApi return and store a ReportObject respectively. Most modifications made to a report loaded at runtime (such as changing filter values) are performed on properties defined within the child types (such as Report or DashboardReport). Such modifications would require a cast of the ReportObject to the appropriate child type.

If modifications are desired, it is necessary to cast the value returned by LoadFromRepository to the appropriate base type. Supported base types include:

WebReports.Api.Reports.Report for Advanced, CrossTab and Express Reports.
WebReports.Api.Composite.Dashboard.DashboardReport for Dashboards.
WebReports.Api.Composite.Chained.ChainedReport for Chained Reports.

Object Model

Syntax

public class ReportObjectFactory

Example

Modify the filters on a report and save them back to the API object.

//Load the report -- Refers to the full folder path
//Followed by the report name
Report report = api.ReportObjectFactory.LoadFromRepository() as Report;
report.Filters[0].Value = ;
//Save the report back to the API
api.ReportObjectFactory.SaveToApi(report);

Inheritance Hierarchy

System.Object
WebReports.Api.Reports.ReportObjectFactory

Reference