Exago .NET API Documentation
Report Class Members
Fields  Properties  Methods 

WebReports.Api.Reports Namespace : Report Class

The following tables list the members exposed by Report.

Public Constructors
 NameDescription
Public Constructor  
Top
Public Fields
 NameDescription
Public Field  
Public Field  
Public Field  
Top
Public Properties
 NameDescription
Public Property  
Public Property  
Public Property  
Public PropertyOverridden.  Determine whether this report object can be exported to CSV.  
Public PropertyOverridden.  Determine whether this report object can be exported to Excel.  
Public PropertyOverridden.  Determine whether this report object can be exported to HTML.  
Public PropertyOverridden.  Determine whether this report object can be exported to PDF.  
Public PropertyOverridden.  Determine whether this report object can be exported to RTF.  
Public Property Access the ApiReportOptions for this report. Used primarily to add Entities from injected SQL and configure a few option options EX-9535; EX-9722 make this public  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property Retrieve the collection of CrossTabs defined within this report  
Public Property  
Public Property  
Public PropertyOverridden.  Retrieve the description text for this report.  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public PropertyOverridden.  Returns the report Entities for advanced/ExpressView/Express reports. Not implemented for dashboard viz's, returns empty list for dashboards and chained reports  
Public Property  
Public Property  
Public Property  
Public PropertySets the default output to show grid lines or not in the Report Viewer. This can be overridden on a per-report basis.  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public PropertyOverridden.  Retrieve the saved export type for this report.  
Public PropertyOverridden.  Retrieve the filter description text for this report.  
Public Property  
Public Property  
Public Property  
Public Property

The default behavior for Microsoft Excel report exporting runs the entire report on a single Worksheet, whose name is the name of the report.

If a report contains Group Sections, an Excel report can be set to create a new Worksheet for each new instance of a group, by enabling this property.

Elements preceding the first group header will appear on the first page as normal. Each time a new group header is reached, the Excel document will break onto a new worksheet, containing all the contents of the group. The name of each worksheet will be the data field on which the group breaks. If the group breaks on a data category, the Unique Key field will be used to name the worksheet.

For more information, review the Excel: Grouping on Separate Worksheets article in the Knowledge Base.

 
Public Property  
Public Property  
Public PropertyOverridden.  Retrieve the unique id of this report.  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public PropertyOverridden.  Retrieve the full eWebReports name of the report from the root report directory.  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public PropertyOverridden.   
Public Property  
Public PropertyOverridden.  Determine whether this report should be run from the viewer by default through the report tree viewer.  
Public PropertyOverridden.  Retrieve the type of report.  
Public Property  
Public Property  
Public Property  
Public Property  
Public PropertyOverridden.   
Public Property  
Public PropertySets the default output to show grid lines or not in the Report Viewer. This can be overridden on a per-report basis.  
Public PropertySpecify if Report Viewer should display paging, search, and export options.  
Public Property  
Public Property  
Public PropertyThis value indicates whether to show status window during execution.  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Top
Public Methods
 NameDescription
Public Method  
Public Method  
Public MethodOverridden.  Returns an array of Type objects describing which widget types the report contains ie. [Chart, Map, Gauge, ...]  
Public Method  
Public Method  
Public Method  
Public Method  
Public Method Update the collection of JOINs for the existing entities We create a set of JOINs using the system level JOIN information for all entities in the report. If there is already a JOIN for that set of entities then we'll use the existing specification as there maybe custom options. Any unused existing JOIN is tested to see if both its entities still exist and if so we retain it. [EX-8881] Make sure we keep custom JOINs  
Public Method  
Public MethodOverloaded.   
Public Method  
Public Methodstatic (Shared in Visual Basic)  
Public Method Returns all column names that would be generated as a result of executing the report.  
Public Method  
Public Method  
Public Method  
Public Method  
Public Method  
Public Method Returns all SQL statements that would be generated as a result of executing the report (there may be more than one SQL statement generated if the report uses more than one SQL data source).  
Public Method  
Public MethodOverridden.  Retrieve the XML for this report object.  
Public Method  
Public Methodstatic (Shared in Visual Basic)  
Public MethodOverridden.  Retrieve the XML for this report object.  
Public Method Integrate dynamically created Joins with the existing set of (possibly custom) Joins this.Joins contains the Joins we loaded the parameter buildJoins are produced by examining the entities in the report and the global Joins available. We will override the use of a global join if a custom one exists in the local join collection  
Public Method  
Public Method  
Public Method EX-9535 We may need to reload these later if SetupData has cleared its entities This generally only happens after a DebugSave EX-9722 Use the new AddEntityToCollection method  
Public Method  
Public Method This method must be called after the associated report has been altered by adding/removing cells, sections, and/or columns.  
Public Method  
Public MethodOverridden.  [EX-9209] The report object is being copied - do any cleanup necessary  
Public Method  
Public MethodOverridden.  Retrieve the serialized xml representation of this report object.  
Public Method  
Public Method  
Top
See Also

Reference

Report Class
WebReports.Api.Reports Namespace