Skip to content

Commit 90f528d

Browse files
committed
Describe jmix.reports.multilineStringsProcessingEnabled property for the Report add-on #981
1 parent 835fae3 commit 90f528d

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

content/modules/reports/pages/configuration.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,13 @@ Activates the xref:exec-history.adoc[report execution history] mechanism.
8383

8484
Default value: `false`.
8585

86+
[[jmix.reports.multilineStringsProcessingEnabled]]
87+
=== jmix.reports.multilineStringsProcessingEnabled
88+
89+
Enables processing of multi-line strings in parameter values for DOCX report templates. When enabled (`true`), line break characters (`\n`, `\r\n`) present in parameter values are rendered as actual line breaks in the generated DOCX document. This functionality is only applied when using a xref:creation/templates.adoc#template_doc[DOCX template].
90+
91+
Default value: `false`.
92+
8693
[[jmix.reports.office-path]]
8794
=== jmix.reports.office-path
8895

content/modules/reports/pages/creation/templates.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,15 @@ select cast(e.year as varchar(4)) as "year"
141141
----
142142
====
143143

144+
[TIP]
145+
====
146+
*Processing Multi-line Strings in DOCX Templates*
147+
148+
By default, line breaks in parameter values are ignored when generating a report. To preserve line breaks (e.g., `\n` or `\r\n`) in the final DOCX output, you must enable the xref:configuration.adoc#jmix.reports.multilineStringsProcessingEnabled[jmix.reports.multilineStringsProcessingEnabled] application property.
149+
150+
*This feature is exclusive to the DOCX report output format and has no effect on other formats like XLSX or PDF.*
151+
====
152+
144153
[[template_html]]
145154
=== HTML Template
146155

0 commit comments

Comments
 (0)