Skip to content

Commit 354ef9a

Browse files
committed
readme: Explain the project purpose and implementation
1 parent 20fb0ad commit 354ef9a

2 files changed

Lines changed: 48 additions & 2 deletions

File tree

README.md

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,58 @@
55
[![](https://img.shields.io/badge/💬_Leave_Feedback-feecdd?style=flat-square)](#does-this-example-address-your-development-requirementsobjectives)
66
<!-- default badges end -->
77

8+
# DevExpress VCL Reports—Generate a PDF Report Using a non-GUI application
9+
10+
This command line application uses the DevExpress VCL Reports components to generate a PDF report.
11+
The application obtains data from a database using a SQL query that includes report layout parameters.
12+
13+
The example includes projects for both [Delphi](./Delphi) and [C++Builder](./CPB).
14+
15+
> ![Example of a PDF report produced by the command line application, showing an alphabetical list of products](./images/report.png)
16+
17+
## Prerequisites
18+
19+
- Microsoft Windows 10 or newer
20+
- Embarcadero RAD Studio IDE 12.3 (Athens) or newer (Community Edition is not supported)
21+
- [Northwind sample database for SQL Server](https://learn.microsoft.com/en-us/dotnet/framework/data/adonet/sql/linq/downloading-sample-databases) as a data source for the report
22+
- DevExpress VCL Components v25.2.3 or newer
23+
24+
## Implementation Details
25+
26+
By following the steps outlined in this example, you'll create a standalone command line application using the
27+
[DevExpress VCL ](https://docs.devexpress.com/VCL/405469/ExpressReports/vcl-reports).
28+
29+
30+
### Prepare a Template Report Layout
31+
32+
An application needs a template report layout, created in the [Report Designer](https://docs.devexpress.com/VCL/405469/ExpressReports/vcl-reports).
33+
You can [store a report layout in a `.repx` file](https://github.com/DevExpress-Examples/vcl-reports-store-layout-template-file)
34+
or [in a database](https://github.com/DevExpress-Examples/vcl-reports-store-layout-template-database).
35+
36+
This example loads a report layout from the [`Layout.repx`](./Layout.repx) file.
37+
38+
###
39+
40+
## Documentation and Examples
41+
42+
- [Documentation: DevExpress VCL Reports](https://docs.devexpress.com/VCL/405469/ExpressReports/vcl-reports)
43+
- [Example: Store Report Layouts within Text Files](https://github.com/DevExpress-Examples/vcl-reports-store-layout-template-file)
44+
- [Example: Store Report Layouts in a Database](https://github.com/DevExpress-Examples/vcl-reports-store-layout-template-database)
45+
46+
## Files to Review
47+
48+
- [`PDFReportGenerator.ini`](./PDFReportGenerator.ini) defines configuration settings used to generate a report.
49+
In your product, you can implement these settings as
50+
- [`Layout.repx`](./Layout.repx) contains visual report layout and database connection data.
51+
- [`Delphi/PDFReportGenerator.dpr`](./Delphi/PDFReportGenerator.dpr) generates a report in headless (non-GUI) mode.
52+
853

954

1055
<!-- feedback -->
11-
## Does This Example Address Your Development Requirements/Objectives?
1256

13-
[<img src="https://www.devexpress.com/support/examples/i/yes-button.svg"/>](https://www.devexpress.com/support/examples/survey.xml?utm_source=github&utm_campaign=vcl-reports-template&~~~was_helpful=yes) [<img src="https://www.devexpress.com/support/examples/i/no-button.svg"/>](https://www.devexpress.com/support/examples/survey.xml?utm_source=github&utm_campaign=vcl-reports-template&~~~was_helpful=no)
57+
## Does This Example Address Your Development Objectives?
58+
59+
[<img src="https://www.devexpress.com/support/examples/i/yes-button.svg"/>](https://www.devexpress.com/support/examples/survey.xml?utm_source=github&utm_campaign=vcl-reports-template&~~~was_helpful=yes)[<img src="https://www.devexpress.com/support/examples/i/no-button.svg"/>](https://www.devexpress.com/support/examples/survey.xml?utm_source=github&utm_campaign=vcl-reports-template&~~~was_helpful=no)
1460

1561
(you will be redirected to DevExpress.com to submit your response)
1662
<!-- feedback end -->

images/report.png

136 KB
Loading

0 commit comments

Comments
 (0)