Image element properties

Open the Properties view in Document Studio and select an Image element. The Properties view displays these available properties for images.




General properties

In the All properties tab, these properties are at the top-level, in the Metadata, and in the Formatting > Common sections.

Type Value Description
Tag String Tag name for the element. This property cannot be edited.
Name String The name of the element.
Description String A summary or note about this element.
Assignment String The variable assignments that are done in the element.
Condition String A script that can apply variables or attributes as conditions on the element.
Master page String Name of the master page that is applied to the element.
Force page change true, false Default value: false

When true, a page break is inserted if current master page is similar to previous one.

Target region String Writes the current element in the region that you specify.
Style name String Name of the style that is applied to the element.



Content properties

In the All properties tab, this property is at the top-level as Content.

Type Value Description
Content String The path to an image file. Supported image formats are dependent on the output format being used. See the appropriate output format reference topic for more information.



Data properties

The Data tab is only visible in the Properties view when there is a query added to the element. In the All properties tab, these properties are at the top-level and in the Data sections.

Type Value Description
Data Source String The data source schema name. You cannot edit this property. Example: Generic XML 1
Context String If the query is on an element that is nested within another element, the context of the parent element is listed for this property. You cannot edit this property. Example: $7 is the context for the parent element.
Query String The name of the query as specified in the data source schema.
Sort String The PUB or native sort that is applied to the element.
Limit String Default value: 0

Enter a number to limit the number of data values in your output.
Filter String The PUB or native filter that is applied to the element.
Recursive Level Number Default value: 0

Instead of adding a query and each of its child queries in your template to extract a set of data, you can use the Recursive Level and Recursive Segments. Use these properties together to specify only the parent query in your template and extract data from that query and all of its child queries.

The Recursive Level is the number of times the recursive segments in the query are repeated. Example: In the query Module/Object/Link/Linked Object, if you entered 2 for the recursive segment value and 3 for the recursive level value, Link/Linked Object would be repeated 3 times. The resulting query is Module/Object/Link/Linked Object/Link/Linked Object/Link/Linked Object.
Recursive Segments Number Default value: 1

Instead of adding a query and each of its child queries in your template to extract a set of data, you can use the Recursive Level and Recursive Segments. Use these properties together to specify only the parent query in your template and extract data from that query and all of its child queries.

The number of segments in the query that are to be repeated. Example: In the query Module/Object/Link/Linked Object, if you entered 2 for the recursive segment value, Link/Linked Object are the segments that are repeated.



Specific properties

In the All properties tab, these properties are located in the Formatting > specific section.

Type Value Description
Image alignment left, right, center Where the image is located in relation to the page margins.
Image indent 0 to infinite The number of pixels of white space between the page margin and the image.
Inherited data configuration String Data source whose properties are used for configuring the target data source. This property allows you to reference resources that are password protected.
Note: Multi-level inheritance is not supported. You cannot set this property to a data source that inherits credentials from another data source.
Hyperlink String Enter the URL that you want the image to link to.
Image map String

You can define a clickable region by adding an HTML snippet to an image element of a template.



Border properties

In the All properties tab, these properties are located in the Formatting > Border sections.

Type Value Description
Margin 0 to 1000 The white space between the sides of the text the border style property is applied to and any other text or element
Example:
All borders margin example
Style none, single, thick, double, hairline, dotted, dash large gap, dot dash, dot dot dash, triple, thin thick small gap, thick thin small gap, thin thick thin small gap, thin thick medium gap, thick thin medium gap, thin thick thin medium gap, thin thick large gap, thick thin large gap, thin thick thin large gap, wave, double wave, dash small gap, dash dot stroker, emboss 3D, engrave 3D, outset, inset, groove, ridge, dashed, hidden The type of border used around the side of the element
Color 000000 to FFFFFF The hexadecimal color of the border on the side of the text in the element
Note: Do not set color to transparent for all borders.
Width 0 to 30 The number of pixels the width of the border of the side of the element is.



Size properties

In the All properties tab, these properties are located in the Formatting > Size sections.

Type Value Description
Image width Number The number of pixels or points horizontally the image is.
Image height Number The number of pixels or points vertically the image is.
Image max width Number The maximum number of pixels or points horizontally the image is. If the image is more than the value entered, the image is scaled proportionally to that number.
Image max height Number The maximum number of pixels or points vertically the image is. If the image is more than the value entered, the image is scaled proportionally to that number.
Maintain image aspect ratio true, false

When set to true, the proportional relationship between width and height of an image is maintained.

The aspect ratio and dimensions of an image are not considered when an image is provided with height and width in pixels. However, if you provide only height in pixels and not width, then the width is decided according to the aspect ratio of the image, considering the height. If you provide only width in pixels and not height, then the height is decided according to the aspect ratio of the image, considering the width.