Expression Elements
- 23 Aug 2024
- 2 Minutes to read
- DarkLight
Expression Elements
- Updated on 23 Aug 2024
- 2 Minutes to read
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
General
An expression element can be used to insert the return value of an Introduction into a Template.
Example: This type of element can be used to insert the values of Datasource variables or fields into a Template.
Expression elements can be placed in the following parts of a Microsoft Excel Workbook:
- Cell
- Worksheet Title
- Header/Footer of the page settings of a worksheet
Properties
Expression elements have the following properties:
Name | Description |
|---|---|
| Name | The name of the expression element. This name will be displayed in the tree hierarchy of the content explorer of the Report Designer. |
| Code | The code of the expression element. There must be no other report element within the same report with the same code. The code is used to reference the report element from within a Template (see below). |
| Condition | An optional condition Expression; if it returns True or 1 the condition is considered to be fulfilled and the result of the expression will be included in the report document. If it returns something other than True or 1 the exclusion settings (see below) will be applied. If you leave this property empty, the condition is considered to be always fulfilled. The condition expression is evaluated after the preparation Actions of the expression element have been executed. |
| Preparation Actions | A list of Actions that will be executed before the expression element will be processed. |
| Fail On Filter Exception | Determines what shall happen if an exception occurs when executing a preparation action that performs a filter (e.g. because the value to which you want to filter does not exist). When enabled, an exception will be thrown and the report document creation will be cancelled; when disabled, the exclusion settings (see below) will be applied. |
| Value | The Expression whose return value to insert into the template. |
| Exclusion Behavior | Exclude Element. When choosing this option and the expression element needs to be excluded, the element will simply be ommitted from the output and an optional replacement text (see below) may be inserted. Exclude Row(s). If you choose this option, the row that contains the reference to the report element will be remvoed from the report document. Exclude Sheet. If you choose this option, the sheet that contains the reference to the report element will be removed from the report document. |
| Replacement Text | An optional Expression that returns a String that contains the replacement text to insert into the report document when the report element needs to be excluded (e.g. if the condition is not fulfilled). Not all exclusion behaviors support a replacement text. |
Insertion
You can insert the placeholder for the expression element by dragging and dropping the report element from the content explorer of the Report Designer into the template. You will then see a placeholder with the following syntax:
Expression Element Placeholder
%%<code>%%
NOTE
If you change the code of an expression element after you have inserted the placeholder into the template, you need to change the placeholder in the template as well. Otherwise error messages will occur when creating the report document.
Was this article helpful?