Skip to content

Update project examples and readme#2

Open
NickVolynkin wants to merge 5 commits into25.2.3+from
25.2.3-volynkin-update-examples
Open

Update project examples and readme#2
NickVolynkin wants to merge 5 commits into25.2.3+from
25.2.3-volynkin-update-examples

Conversation

@NickVolynkin
Copy link

@NickVolynkin NickVolynkin commented Feb 4, 2026

readme: Update instructions

Readme preview: https://github.com/DevExpress-Examples/vcl-reports-store-layout-template-file/blob/25.2.3-volynkin-update-examples/README.md

repo: Add a Delphi/C++Builder gitignore file

delphi/cpp-builder: Update and clarify the example

  • Fix the SQLite connection string: correct path to nwind.db.
  • Before saving a report, pass the name to the file save dialog.
  • Assign a name and icon to the application.
  • Clarify error messages in message boxes.
  • Always update the application caption when report changes.
  • Extract a method to load a report and update the application caption.
  • [cpp-builder] Rename the project to match Delphi project name.

before:

before

after:

app

@NickVolynkin NickVolynkin self-assigned this Feb 4, 2026
@NickVolynkin NickVolynkin force-pushed the 25.2.3-volynkin-update-examples branch 8 times, most recently from dd68e24 to 897c71b Compare February 4, 2026 18:31
@NickVolynkin NickVolynkin force-pushed the 25.2.3-volynkin-update-examples branch from 7e1cd67 to 59e831f Compare February 5, 2026 09:20
@NickVolynkin NickVolynkin marked this pull request as ready for review February 5, 2026 10:23
@NickVolynkin NickVolynkin force-pushed the 25.2.3-volynkin-update-examples branch 3 times, most recently from 6139e7b to 21bb8d3 Compare February 5, 2026 12:52
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't use semicolons in group titles. And I would probably go with singular "Report Layout". You can create a layout, open a layout, save a layout. All those actions apply to a single layout. We're not listing multiple layouts in that group:

  • Report Layout
  • Display Report Dialogs

The form caption is a little confusing. I see this screenshot early in the article... and I assume that you can only work with a Table Report in this example. I assume that's the app title. We need to make it clear that it's just a name of the currently loaded report. So maybe do it like this:

"TableReport.repx - Report Layout"

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a strict limitation: app window is rather small and long captions don't fit. However, I'll do what I can to make it clear.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume that you can only work with a Table Report in this example

The application can load any report file, not just the one included.

README.md Outdated

1. Run the sample app and click **New Report**.
1. Create a report layout (template) using tools available in the DevExpress [Report Designer](https://docs.devexpress.com/XtraReports/119176/web-reporting/web-end-user-report-designer).
1. Click the hamburger button, select the **Save** option, enter a report template name, and close the dialog.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would set the context here, because I was a bit confused about the hamburger button, as I don't see it on the screenshot.

Suggested change
1. Click the hamburger button, select the **Save** option, enter a report template name, and close the dialog.
1. Once you're done with changes in the **Report Designer** dialog, click the hamburger button, select **Save**, and enter a report template name. Close the dialog.

BTW, it seems that I saved the report layout already, in this step. But then, in the next step, I have to click the Save button again (on the main app form). Should we explain why I need to go through the save process twice? Maybe we need to mention here, that this action doesn't actually save the report yet. But I'm not sure how it works.

Copy link
Author

@NickVolynkin NickVolynkin Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. Maybe we should use completely distinct terms for file operations, such as Import from file and Export to file. This naming would highlight the difference from saving layouts in a Report Designer.

However, the methods to import and export layouts are still LoadFromFile and SaveToFile, as the Layout property inherits a simple TString.

@NickVolynkin NickVolynkin force-pushed the 25.2.3-volynkin-update-examples branch 6 times, most recently from b8ed37f to d3c24ec Compare February 6, 2026 15:03
- Fix the SQLite connection string: correct path to nwind.db.
- Before saving a report, pass the name to the file save dialog.
- Assign a name and icon to the application.
- Clarify error messages in message boxes.
- Always update the application caption when report changes.
- Extract a method to load a report and update the application caption.
- Fix the SQLite connection string: correct path to nwind.db.
- Before saving a report, pass the name to the file save dialog.
- Extract a method to load a report and update the application caption.
- Check the file existence before opening a report.
- Assign a name and icon to the application.
- Clarify error messages in message boxes.
- Always update the application caption when report changes.
- Rename the project to match Delphi project name.
@NickVolynkin NickVolynkin force-pushed the 25.2.3-volynkin-update-examples branch 3 times, most recently from 0a468c3 to 8fcaed1 Compare February 6, 2026 15:44
@NickVolynkin NickVolynkin force-pushed the 25.2.3-volynkin-update-examples branch 9 times, most recently from 54be2da to c47aea8 Compare February 6, 2026 16:43
Co-authored-by: Dmitry Eliseev <81766219+dmitry-eliseev-devexpress@users.noreply.github.com>
Co-authored-by: Vladimir Abadzhev <vladimira@devexpress.com>
@NickVolynkin NickVolynkin force-pushed the 25.2.3-volynkin-update-examples branch from 99f3f33 to 134db07 Compare February 6, 2026 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants