Exago .NET API Documentation
ReportObject Class Members
Fields  Properties  Methods 

WebReports.Api.Reports Namespace : ReportObject Class

The following tables list the members exposed by ReportObject.

Public Fields
 NameDescription
Public FieldCurrentLoadedPages The number of pages currently loaded browser side. This information is used when resuming data pulls  
Public FieldDbRowLimitCounter The row limit counter is used in conjunction with Admin settings to calculate the Effective DB Row Limit for an execution of this report  
Public FieldMetOrExceededDbRowLimit Flag indicating whether or not the report hit the effective db limit during execution  
Public FieldRangeEnd Last data row index for a data range limit  
Public FieldRangeStart First data row index for a data range limit  
Public FieldResumeDataPull ResumeDataPull flags the report during execution to treat it as resuming data instead of new or replacement data  
Top
Public Properties
 NameDescription
Public PropertyAllowOutputCsv Determine whether this report object can be exported to CSV.  
Public PropertyAllowOutputExcel Determine whether this report object can be exported to Excel.  
Public PropertyAllowOutputHtml Determine whether this report object can be exported to HTML.  
Public PropertyAllowOutputPdf Determine whether this report object can be exported to PDF.  
Public PropertyAllowOutputRtf Determine whether this report object can be exported to RTF.  
Public PropertyBaseName Retrieve the eWebReports name of the report without the folder path.  
Public PropertyDescription Retrieve the description text for this report.  
Public PropertyEntities Returns the report Entities for advanced/ExpressView/Express reports. Not implemented for dashboard viz's, returns empty list for dashboards and chained reports  
Public PropertyExecExportType Retrieve the current effective export type for this report.  
Public PropertyExportType Retrieve the saved export type for this report.  
Public PropertyFilterDescription Retrieve the filter description text for this report.  
Public PropertyFolderId  
Public PropertyFolderName Retrieve the full eWebReports folder path of the report from the report repository.  
Public PropertyId Retrieve the unique id of this report.  
Public PropertyIsEditAllowed Determine whether editing of this report is allowed by the current configuration. ie., can the user view this report type, and is the containing folder visible?  
Public PropertyIsExecuteAllowed Determine whether execution of this report is allowed by the current configuration.  
Public PropertyIsNew Whether this report object is new (i.e. not in report repository)  
Public PropertyIsReadOnly Determine whether this report is considered readonly by the current configuration.  
Public PropertyIsResumable  
Public PropertyMetadata  
Public PropertyName Retrieve the full eWebReports name of the report from the root report directory.  
Public PropertyParentId Retrieve the unique parent id of this report.  
Public PropertyParentReportType Retrieve the parent type of report.  
Public PropertyParentUdf  
Public PropertyReportId  
Public PropertyReportTreeShortcut Determine whether this report should be run from the viewer by default through the report tree viewer.  
Public PropertyReportType Retrieve the type of report.  
Public PropertyServerEvents  
Public PropertyTransformedExpressView  
Public PropertyValidationErrors Retrieve a list of any validation errors logged from the most recent Validate call (or load).  
Top
Public Methods
 NameDescription
Public Methodstatic (Shared in Visual Basic)CreateMetadataOverloaded.   
Public MethodIsExportTypeAllowed Determine if the export type is allowed for this report.  
Public MethodValidate Validate the current report. The ValidationErrors property will be refreshed to contain the most recent validation errors.  
Top
See Also

Reference

ReportObject Class
WebReports.Api.Reports Namespace

 

 

Version: 2021.2.6 Last published: 5/18/2022

Contact Exago Support