Skip to content

Commit 00d8b7d

Browse files
committed
readme: Explain the project purpose and implementation
1 parent 9b2bd30 commit 00d8b7d

3 files changed

Lines changed: 44 additions & 3 deletions

File tree

.github/meta.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# GitHub Repository metadata
2-
url: vcl-reports-export-pdf-report-command-line
2+
url: vcl-reports-headless-export
33
description: Generate DevExpress VCL Reports in headless (non-GUI) applications.
44
tags: [vcl, layout, reports, command-line, pdf]

README.md

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

7+
# DevExpress VCL Reports—Generate a PDF Report Using a non-GUI application
8+
9+
This command line application uses the DevExpress VCL Reports components to generate a PDF report.
10+
The application obtains data from a database using a SQL query that includes report layout parameters.
11+
12+
The example includes projects for both [Delphi](./Delphi) and [C++Builder](./CPB).
13+
14+
> ![Example of a PDF report produced by the command line application, showing an alphabetical list of products](./images/report.png)
15+
16+
## Prerequisites
17+
18+
See: [DevExpress Reports Prerequisites](https://docs.devexpress.com/VCL/405768/ExpressCrossPlatformLibrary/general-recommendations/vcl-web-view-2-based-app-deployment#vcl-reportsdashboards-prerequisites)
19+
20+
21+
## Implementation Details
22+
23+
By following the steps outlined in this example, you'll create a standalone command line application using the
24+
[DevExpress VCL ](https://docs.devexpress.com/VCL/405469/ExpressReports/vcl-reports).
25+
26+
### Prepare a Template Report Layout
27+
28+
An application needs a template report layout, created in the [Report Designer](https://docs.devexpress.com/VCL/405469/ExpressReports/vcl-reports).
29+
You can [store a report layout in a `.repx` file](https://github.com/DevExpress-Examples/vcl-reports-store-layout-template-file)
30+
or [in a database](https://github.com/DevExpress-Examples/vcl-reports-store-layout-template-database).
31+
32+
This example loads a report layout from the [`Layout.repx`](./Layout.repx) file.
33+
34+
###
35+
36+
## Documentation and Examples
37+
38+
- [Documentation: DevExpress VCL Reports](https://docs.devexpress.com/VCL/405469/ExpressReports/vcl-reports)
39+
- [Example: Store Report Layouts within Text Files](https://github.com/DevExpress-Examples/vcl-reports-store-layout-template-file)
40+
- [Example: Store Report Layouts in a Database](https://github.com/DevExpress-Examples/vcl-reports-store-layout-template-database)
41+
42+
## Files to Review
43+
44+
- [`PDFReportGenerator.ini`](./PDFReportGenerator.ini) defines configuration settings used to generate a report.
45+
In your product, you can implement these settings as
46+
- [`Layout.repx`](./Layout.repx) contains visual report layout and database connection data.
47+
- [`Delphi/PDFReportGenerator.dpr`](./Delphi/PDFReportGenerator.dpr) generates a report in headless (non-GUI) mode.
48+
749

8-
950
<!-- feedback -->
10-
## Does this example address your development requirements/objectives?
51+
## Does This Example Address Your Development Requirements/Objectives?
1152

1253
[<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-filter-export-report-pdf-in-console-app&~~~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-filter-export-report-pdf-in-console-app&~~~was_helpful=no)
1354

images/report.png

136 KB
Loading

0 commit comments

Comments
 (0)