Skip to content

Commit 2aecdd1

Browse files
committed
readme: Add documentation, reference, and example links
1 parent 81b3abc commit 2aecdd1

1 file changed

Lines changed: 67 additions & 8 deletions

File tree

README.md

Lines changed: 67 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,86 @@
44
[![](https://img.shields.io/badge/📖_How_to_use_DevExpress_Examples-e9f6fc?style=flat-square)](https://docs.devexpress.com/GeneralInformation/403183)
55
[![](https://img.shields.io/badge/💬_Leave_Feedback-feecdd?style=flat-square)](#does-this-example-address-your-development-requirementsobjectives)
66
<!-- default badges end -->
7-
# DevExpress VCL Reports - Data Record Filtering in a Report
87

9-
This example allows you to select individual dataset records in a DevExpress VCL [Data Grid](https://docs.devexpress.com/VCL/cxGrid.TcxGrid?v=25.2) control and display selected records in a built report using the [Report Viewer](https://docs.devexpress.com/XtraReports/401850/web-reporting/web-document-viewer) dialog.
10-
Source data is stored in a memory-based dataset ([TdxMemData](https://docs.devexpress.com/VCL/dxmdaset.TdxMemData) inherited from the [TDataSet](https://docwiki.embarcadero.com/Libraries/Athens/en/Data.DB.TDataSet) class shipped with the standard VCL library).
8+
9+
# DevExpress Reports for Delphi/C++Builder – Filter Data Records in a Report
10+
11+
This example allows you to select individual dataset records in a DevExpress VCL [Data Grid][TcxGrid]
12+
control and display selected records in a built report using the [Report Viewer][report-viewer] dialog.
13+
Source data is stored in a memory-based dataset ([TdxMemData]
14+
inherited from the [TDataSet] class shipped with the standard VCL library).
1115

1216
## Prerequisites
1317

14-
* Microsoft Windows 10 or newer
15-
* Embarcadero RAD Studio IDE 12.3 (Athens) or newer (Community Edition is not supported)
16-
* DevExpress VCL Components v25.2.3 or newer
18+
[DevExpress Reports Prerequisites][req]
19+
20+
[req]: https://docs.devexpress.com/VCL/405773/ExpressCrossPlatformLibrary/vcl-backend/reports-dashboards-app-deployment#vcl-reportsdashboards-prerequisites
1721

18-
## Testing the example
22+
## Test the Example
1923

2024
Run the sample app and check any records in a table:
2125

2226
![Data Record Selection](/vcl-reports-selected-grid-records.png)
2327

24-
Click the **Preview Report** button to display a report containing all selected records in the [Report Viewer](https://docs.devexpress.com/XtraReports/401850/web-reporting/web-document-viewer) dialog.
28+
Click the **Preview Report** button to display a report containing all selected records in the [Report Viewer][report-viewer] dialog.
2529

2630
![Selected Records in a Sample Report](/vcl-reports-sample-report-with-selected-records.png)
2731

32+
33+
## Documentation
34+
35+
- [Introduction to DevExpress Reports for Delphi/C++Builder][reports-intro]
36+
- [Tutorial: Create a table report using the Report Wizard][report-wizard]
37+
- [Use JSON as a data source for dashboards (as demonstrated in the current example)][json-data-source]
38+
- [Store report layouts in REPX files at design-time][reports-design-time-store]
39+
- API reference:
40+
- [TdxReport]
41+
- [TdxReport.ReportName] (internal report name)
42+
- [TdxReport.Layout] (an XML-based layout template that can be stored in a BLOB data field)
43+
- [TdxReport.ShowViewer]
44+
- [TdxMemData] (DevExpress in-memory dataset implementation)
45+
- [TDataSet] (contains generic database connection methods)
46+
- [TdxBackendDataSetJSONConnection] (supplies data to reports)
47+
48+
<!-- documentation links -->
49+
50+
[report-viewer]: https://docs.devexpress.com/XtraReports/401850/web-reporting/web-document-viewer
51+
[reports-intro]: https://docs.devexpress.com/VCL/405469/ExpressReports/vcl-reports
52+
[report-wizard]: https://docs.devexpress.com/VCL/405760/ExpressReports/getting-started/create-table-report-using-report-wizard
53+
[json-data-source]: https://docs.devexpress.com/VCL/405747/ExpressCrossPlatformLibrary/vcl-backend/database-engines/vcl-backend-memory-based-data-storage
54+
[reports-design-time-store]: https://docs.devexpress.com/VCL/dxReport.TdxReport.Layout#string-list-editor
55+
56+
57+
<!-- reference links -->
58+
[TcxGrid]: https://docs.devexpress.com/VCL/cxGrid.TcxGrid?v=25.2
59+
[TdxReport]: https://docs.devexpress.com/VCL/dxReport.TdxReport
60+
[TdxReport.Layout]: https://docs.devexpress.com/VCL/dxReport.TdxReport.Layout
61+
[TdxReport.ReportName]: https://docs.devexpress.com/VCL/dxReport.TdxReport.ReportName
62+
[TdxReport.ShowViewer]: https://docs.devexpress.com/VCL/dxReport.TdxReport.ShowViewer
63+
[TdxBackendDataSetJSONConnection]: https://docs.devexpress.com/VCL/dxBackend.ConnectionString.JSON.DataSet.TdxBackendDataSetJSONConnection
64+
[TdxMemData]: https://docs.devexpress.com/VCL/dxmdaset.TdxMemData
65+
66+
<!-- external documentation links -->
67+
[TDataSet]: https://docwiki.embarcadero.com/Libraries/Athens/en/Data.DB.TDataSet
68+
69+
<!-- in-repository links -->
70+
[uMainForm.pas]: ./Delphi/uMainForm.pas
71+
[uMainForm.cpp]: ./CPB/uMainForm.cpp
72+
73+
74+
## More Examples
75+
76+
- [Store report layouts in REPX files][file-example]
77+
- [Store Report Layouts in a Database][database-example]
78+
- [Generate reports in a backend / service application][non-interactive-export]
79+
- [Localize the Report Viewer and Report Designer][localize]
80+
81+
[file-example]: https://github.com/DevExpress-Examples/vcl-reports-store-layout-template-file
82+
[database-example]: https://github.com/DevExpress-Examples/vcl-reports-store-layout-template-database
83+
[non-interactive-export]: https://github.com/DevExpress-Examples/vcl-reports-non-interactive-export
84+
[localize]: https://github.com/DevExpress-Examples/vcl-reports-localize
85+
86+
2887
<!-- feedback -->
2988
## Does This Example Address Your Development Requirements/Objectives?
3089

0 commit comments

Comments
 (0)