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== | |
| − | == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
The Reports module contains the following items: | The Reports module contains the following items: | ||
| − | |||
| − | ! width=25% | + | {| class="genericTable" |
| − | + | ! width=25% | Item | |
| − | ! width=55% | + | ! width=55% | Description |
|- | |- | ||
| − | | | + | |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). | ||
| − | |||
|- | |- | ||
| − | | | + | |[[DataSet]] |
|The interface that provides data access for the report. | |The interface that provides data access for the report. | ||
| − | |||
|- | |- | ||
| − | | | + | |[[RBReportDocument]] |
|The document that is generated when the report is run. | |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. | ||
| − | [[Category: | + | [[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.