ReportDocument Members
Represents a report and contains properties and methods to define, format, load, export, and print the report.
The following tables list the members exposed by the ReportDocument type.
Public Properties
Property | Description | |
---|---|---|
![]() |
Database | Gets the Database object. |
![]() |
DataDefinition | Gets the DataDefinition object. |
![]() |
DataSourceConnections | A collection of IConnectionInfo objects which contains connection info of all the tables in the report. This does not include the subreports. |
![]() |
EnterpriseSession | Gets or sets the reference to the EnterpriseSession object when the RAS server is managed by BusinessObjects Enterprise. |
![]() |
ExportOptions | Gets the ExportOptions class instance. |
![]() |
FileName | Specifies the name of the report file. If protocol or drive letter is specified, a "ras://" default is assumed. |
![]() |
FilePath | Specifies the name of the report file without the protocol prefix. |
![]() |
HasSavedData | Gets whether the report has data saved in memory. |
![]() |
IsLoaded | Gets whether the report has been loaded using the Load method. |
![]() |
IsSubreport | Gets whether the report is a subreport. |
![]() |
Name | Gets the report name. For the main report, the report name is empty. |
![]() |
ParameterFields | Gets the parameter fields. |
![]() |
PrintOptions | Gets the PrintOptions object. |
![]() |
RecordSelectionFormula | Gets or sets record selection formula. |
![]() |
ReportAppServer | Gets or sets the name of the Report Application Server (also know as the RAS Server). |
![]() |
ReportClientDocument | The ReportClientDocument class is an entry point to the underlying Report Application Server API. If ReportDocument.ReportAppServer does not point to a Report Application Server, this property will throw an exception. |
![]() |
ReportDefinition | Gets the ReportDefinition object. |
![]() |
ReportOptions | Gets the ReportOptions object. |
![]() |
Subreports | Subreports. Gets the Subreports object. |
![]() |
SummaryInfo | Gets the SummaryInfo object. |
Top
Public Methods
Method | Description | |
---|---|---|
![]() |
Close | Closes the report. |
![]() |
EnableEventLog | Enables the event log for the print engine. By default the log is not enabled. |
![]() |
Export | Exports a report to a format and destination specified within the ExportOptions Object. |
![]() |
ExportToDisk | Exports a report to a file in the specified format. |
![]() |
ExportToHttpResponse | Overloaded. Exports a report to the response object in the specified format. |
![]() |
ExportToStream | Exports a report to a stream in the specified format. |
![]() |
GetConcurrentUsage | Returns the number of concurrent jobs opened allowing developers to build license monitoring into their applications. |
![]() |
Load | Overloaded. Loads a new report and sets the OpenReportMethod enumeration. If a report is already loaded, then it is closed and a new one is opened. |
![]() |
OpenSubreport | Opens a subreport contained in the report and returns a ReportDocument object corresponding to the named subreport. |
![]() |
PrintToPrinter | Prints the specified pages of the report to the printer selected using the PrintOptions.PrinterName property. If no printer is selected, the default printer specified in the report will be used. |
![]() |
Refresh | Removes saved data. This causes fresh data to be loaded when the report is subsequently viewed. |
![]() |
SaveAs | Overloaded. Saves the report and its data into the specified file. |
![]() |
SetCssClass | Sets the cascading style sheet (CSS) for various sections and report objects. |
![]() |
SetDatabaseLogon | Overloaded. Sets the database logon information with a user name and password. |
![]() |
SetDataSource | Overloaded. Passes an Object to the report engine. |
![]() |
SetParameterValue | Overloaded. Sets the current value of a parameter field at the specified index. The value can be a primitive, ParameterValue, an array of either type, or a ParameterValues collection. |
![]() |
VerifyDatabase | Checks whether the database connection is active for the report that is loaded by the ReportDocument object. |
Top