Difference between revisions of "Reports"

From Xojo Documentation

m (1 revision)
 
(Notes)
 
(24 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 +
{{ModuleBox
 +
| name=Reports
 +
}}
 +
{{Description
 +
|text = Used by the [[Report]] class to create reports.}}
  
 
+
==Notes==
=='''Description'''==
 
Used by the [[Report|Report]] class to create reports.
 
 
 
 
 
 
 
=='''Notes'''==
 
 
The Reports module contains the following items:
 
The Reports module contains the following items:
{| cellpadding="8" cellspacing="0" border="1"
 
  
! width=25% style="background-color:#e0e0e0" | Item
+
{| class="genericTable"
 
+
! width=25% | Item
! width=55% style="background-color:#e0e0e0" | Description
+
! width=55% | Description
 
|-
 
|-
|'''Reports'''.[[Units|Units]]
+
|Units
 
|An Enum that contains the Units in which the report's dimensions are measured (pixels, inches, or millimeters).
 
|An Enum that contains the Units in which the report's dimensions are measured (pixels, inches, or millimeters).
 
 
|-
 
|-
|'''Reports'''.[[DataSet|DataSet]]
+
|[[DataSet]]
 
|The interface that provides data access for the report.
 
|The interface that provides data access for the report.
 
 
|-
 
|-
|'''Reports'''.[[RBReportDocument|RBReportDocument]]
+
|[[RBReportDocument]]
 
|The document that is generated when the report is run.
 
|The document that is generated when the report is run.
 
 
|-
 
|-
|'''Reports'''.[[RecordSetQuery|RecordSetQuery]]
+
|[[Report.Run]]
|A class that takes a [[RecordSet|RecordSet]] and makes it usable to the reporting engine.
+
|Method that when called generates the report from the [[RowSet]] or [[DataSet]] passed.
 
 
 
|-
 
|-
 
|}
 
|}
  
 +
Because these items are apart of the Reports module, they must be prefixed with it to access them For example, to access the the [[RBReportDocument]], you'd use Reports.RBReportDocument.
  
See the two example projects, Gas Report and Database Example, for examples of reports. The two projects differ mainly in that the Gas Report uses a text file as its data source while the Database Example uses a REAL SQL Server dataset. The Gas Report uses the Reports.DataSet interface to obtain the data for the reporting engine while the Example Database uses Reports.[[RecordSetQuery|RecordSetQuery]] to obtain the data from a [[RecordSet|RecordSet]].
+
== Sample Code ==
 
+
Refer to Examples/Printing and Reporting/Reporting for example projects.
 
 
  
=='''See Also'''==
+
==Compatibility==
[[Report|Report]], [[RBReportDocument|RBReportDocument]], [[ReportField|ReportField]], [[Report|Report]], [[ReportLabel|ReportLabel]], [[ReportLineShape|ReportLineShape]], [[ReportOvalShape|ReportOvalShape]], [[ReportRectangleShape|ReportRectangleShape]], [[ReportPicture|ReportPicture]] classes.
+
Desktop projects on Linux, MacOS and Windows operating systems.
  
 +
==See Also==
 +
[[Report]], [[RBReportDocument]], [[ReportField]], [[Report]], [[ReportLabel]], [[ReportPageNumberLabel]], [[ReportLineShape]], [[ReportOvalShape]], [[ReportRectangleShape]], [[ReportPicture]] classes.
  
[[Category:Modules]]
+
[[Category:Reports]]
 +
[[Category:Reports_Modules]]
 +
[[Category:Desktop]]

Latest revision as of 22:11, 1 February 2022

Module

Used by the Report class to create reports.

Notes

The Reports module contains the following items:

Item Description
Units An Enum that contains the Units in which the report's dimensions are measured (pixels, inches, or millimeters).
DataSet The interface that provides data access for the report.
RBReportDocument The document that is generated when the report is run.
Report.Run Method that when called generates the report from the RowSet or DataSet passed.

Because these items are apart of the Reports module, they must be prefixed with it to access them For example, to access the the RBReportDocument, you'd use Reports.RBReportDocument.

Sample Code

Refer to Examples/Printing and Reporting/Reporting for example projects.

Compatibility

Desktop projects on Linux, MacOS and Windows operating systems.

See Also

Report, RBReportDocument, ReportField, Report, ReportLabel, ReportPageNumberLabel, ReportLineShape, ReportOvalShape, ReportRectangleShape, ReportPicture classes.