Image Elements

Updated on 03 Dec 2024
3 Minutes to read

Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

General

This type of report element can be used to load an image from a local or UNC file path or a web URL and insert it into the Template.

Example: You can load the company logo of your report recipients dynamically from the file system and read the path to the image file from a Datasource variable or field.

Properties

Image elements have the following properties:

Name	Description
Name	The name of the image element. This name will be displayed in the tree hierarchy of the content explorer of the Report Designer.
Code	The code of the image 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 image 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 image element have been executed.
Preparation Actions	A list of Actions that will be executed before the image 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.
Source	URI or AWS S3. Determines if the image is an URI or located in a AWS S3 Bucket or a S3 Compatible storage Bucket. Version 3.5.9 and higher.
AWS Connection	if Source is AWS S3: Connection (previously defined in AWS S3 Bucket Connections) where the image is located. Version 3.5.9 and higher.
Remote Path	if Source is AWS S3: An Expression that returns a string that contains the path from which to load the image. Version 3.5.9 and higher.
Source URI	if Source is URI: An Expression that returns a string that contains the URL from which to load the image. This can be a local or UNC file path or a web URL.
Keep Original Size	When enabled the original size of the image will be kept by ignoring the size of the placeholder of the image element in the template.
Exclusion Behavior	Exclude Element. When choosing this option and the image 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 image 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 image within the template that you can position and resize to the desired output size.

NOTE

If you change the code of a image element after you have inserted the placeholder into the template, you need to remove the placeholder from the template and insert the image element again. Otherwise error messages will occur when creating the report document.

Was this article helpful?

What's Next

Repeater Elements

Table of contents