Skip to content

Commit 1035f0a

Browse files
NickVolynkinNickVolynkin
committed
readme: add two versions for review
Provide links to documentation; add a note about VCL library localization
1 parent e553e83 commit 1035f0a

2 files changed

Lines changed: 64 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,14 @@ This example localizes DevExpress VCL Reports components in Delphi and C++ Build
1111

1212
The [DevExpress Reporting Platform](https://docs.devexpress.com/VCL/405469/ExpressReports/vcl-reports)
1313
fully supports UI localization. Projects in this repository give users a choice between English (default) and German (localized) versions of two built-in dialogs: [Report Viewer](https://docs.devexpress.com/XtraReports/401850/web-reporting/web-document-viewer) and
14-
[Report Designer](https://docs.devexpress.com/XtraReports/119176/web-reporting/web-end-user-report-designer).
14+
[Report Designer](https://docs.devexpress.com/XtraReports/119176/web-reporting/web-end-user-report-designer).
15+
The repository has example projects in [Delphi](./Delphi) and [C++ Builder](./CPB).
16+
17+
**To localize the DevExpress Report Designer and Report Viewer interface** in your Delphi or C++ Builder project, refer to the following guide:
18+
[Report Viewer and Designer UI Localization](https://docs.devexpress.com/VCL/405598/ExpressReports/localization/vcl-report-viewer-and-designer-localization).
19+
20+
**To localize the report contents**, refer to the following guide:
21+
[Report Localization](https://docs.devexpress.com/VCL/405599/ExpressReports/localization/vcl-report-localization).
1522

1623
![Starting screen of the localization example, offering to select between English and German, and to display Report Designer and Report Viewer dialogs](./images/Lokalisierungsbeispiel.png)
1724

@@ -24,12 +31,30 @@ fully supports UI localization. Projects in this repository give users a choice
2431

2532
## Implementation Details
2633

27-
Study and build an example project in your preferred development environment:
34+
To switch the Report Designer and Report Viewer interface to a different language,
35+
assign the language code to the [`Language`](https://docs.devexpress.com/VCL/dxReport.TdxReport.Language) property of a [`TdxReport`](https://docs.devexpress.com/VCL/dxReport.TdxReport) component:
36+
37+
```delphi
38+
dxReport1: TdxReport;
39+
// Switch to German Localization
40+
dxReport1.Language := 'de-DE'
41+
```
42+
43+
A compiled application obtains UI strings for the German locale (`de_DE`) from the following files: [`./Localization/*.de.json`](./Localization).
44+
Learn more about the localization files required for each component from the following guide:
45+
[Localize Core Reporting Components: Use JSON Files](https://docs.devexpress.com/XtraReports/400932/web-reporting/common-features/localization/localization-in-asp-net-core-reporting-applications#use-json-files).
46+
47+
To download localization files for various locales, you can use the [DevExpress Localization Service](https://localization.devexpress.com/).
48+
Learn more from the following guide: [DevExpress UI Localization Service](https://docs.devexpress.com/GeneralInformation/16235/localization/localization-service).
49+
50+
> **Note:** The localization mechanism demonstrated in this example applies only to DevExpress Report Designer and Report Viewer components.
51+
> The DevExpress VCL library components support localization using [resource files and the Localizer Editor](https://docs.devexpress.com/VCL/154039/ExpressCrossPlatformLibrary/how-to/localize-an-application).
2852
29-
- [Delphi](./Delphi)
30-
- [C++ Builder](./CPB)
53+
## Files to Review
3154

32-
A compiled application obtains UI strings for the German locale (`de_DE`) from the following files: [`./Localization/*.de.json`](./Localization). You can use the [DevExpress Localization Service](https://localization.devexpress.com/) to download localization files for various locales.
55+
- [`Delphi\uMainForm.pas`](./Delphi/uMainForm.pas) loads an example report from the file `ExampleReport.repx`.
56+
Event handlers assigned to `TcxRadioButton` components switch localization language between English and German.
57+
- Files in the [`Localization`](./Localization/) contain localized UI strings.
3358

3459
## Documentation
3560

‎README2.md‎

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@
99

1010
This example localizes DevExpress VCL Reports components in Delphi and C++ Builder projects.
1111

12-
The [DevExpress Reporting Platform](https://docs.devexpress.com/VCL/405469/ExpressReports/vcl-reports)
13-
fully supports UI localization. Projects in this repository give users a choice between English (default) and German (localized) versions of two built-in dialogs: [Report Viewer](https://docs.devexpress.com/XtraReports/401850/web-reporting/web-document-viewer) and
14-
[Report Designer](https://docs.devexpress.com/XtraReports/119176/web-reporting/web-end-user-report-designer).
12+
The [DevExpress Reporting Platform](https://docs.devexpress.com/VCL/405469/ExpressReports/vcl-reports) fully supports UI localization.
13+
Projects in this repository give users a choice between English (default) and German (localized) versions of two built-in dialogs: [Report Viewer](https://docs.devexpress.com/XtraReports/401850/web-reporting/web-document-viewer) and
14+
[Report Designer](https://docs.devexpress.com/XtraReports/119176/web-reporting/web-end-user-report-designer).
15+
The repository has example projects in [Delphi](./Delphi) and [C++ Builder](./CPB).
1516

1617
![Starting screen of the localization example, offering to select between English and German, and to display Report Designer and Report Viewer dialogs](./images/Lokalisierungsbeispiel.png)
1718

@@ -24,12 +25,38 @@ fully supports UI localization. Projects in this repository give users a choice
2425

2526
## Implementation Details
2627

27-
Study and build an example project in your preferred development environment:
28+
To localize the DevExpress Report Designer and Report Viewer in your Delphi or C++ Builder application,
29+
use the following steps:
2830

29-
- [Delphi](./Delphi)
30-
- [C++ Builder](./CPB)
31+
1. Determine the localization files you need, consulting the guide [Localize Core Reporting Components: Use JSON Files](https://docs.devexpress.com/XtraReports/400932/web-reporting/common-features/localization/localization-in-asp-net-core-reporting-applications#use-json-files).
32+
2. Sign up for the [DevExpress Localization Service](https://localization.devexpress.com/) and request to download localization files.
33+
To learn more, [refer to the corresponding guide](https://docs.devexpress.com/GeneralInformation/16235/localization/localization-service).
34+
3. Create a `Localization` folder in the same folder as your compiled application executable.
35+
Projects in this repository use `..` as the output path, so that both projects can use the same `Localization` folder.
36+
Extract the downloaded localization files to the `Localization` folder.
37+
4. To switch the Report Designer and Report Viewer interface to a specific language,
38+
assign the language code to the [`Language`](https://docs.devexpress.com/VCL/dxReport.TdxReport.Language) property of a [`TdxReport`](https://docs.devexpress.com/VCL/dxReport.TdxReport) component:
3139

32-
A compiled application obtains UI strings for the German locale (`de_DE`) from the following files: [`./Localization/*.de.json`](./Localization). You can use the [DevExpress Localization Service](https://localization.devexpress.com/) to download localization files for various locales.
40+
```delphi
41+
dxReport1: TdxReport;
42+
// Switch to German Localization
43+
dxReport1.Language := 'de-DE'
44+
```
45+
46+
For a more detailed step-by-step guide to localizing your applications, refer to the documentation:
47+
[Report Viewer and Designer UI Localization](https://docs.devexpress.com/VCL/405598/ExpressReports/localization/vcl-report-viewer-and-designer-localization).
48+
49+
Localizing the contents of specific reports is out of scope for this example.
50+
Refer to the following guide to learn more: [Report Localization](https://docs.devexpress.com/VCL/405599/ExpressReports/localization/vcl-report-localization).
51+
52+
> **Note:** The localization mechanism demonstrated in this example applies only to DevExpress Report Designer and Report Viewer components.
53+
> The DevExpress VCL library components support localization using [resource files and the Localizer Editor](https://docs.devexpress.com/VCL/154039/ExpressCrossPlatformLibrary/how-to/localize-an-application).
54+
55+
## Files to Review
56+
57+
- [`Delphi\uMainForm.pas`](./Delphi/uMainForm.pas) loads an example report from the file `ExampleReport.repx`.
58+
Event handlers assigned to `TcxRadioButton` components switch localization language between English and German.
59+
- Files in the [`Localization`](./Localization/) contain localized UI strings.
3360
3461
## Documentation
3562

0 commit comments

Comments
 (0)