IncludePicture

This command enables the insertion of graphics from a file into the merged document.

The picture is inserted into the document at the point where the command is encountered, and the size of the image is included in the command, for example:

«IncludePicture(images:Logo.jpg,0.8in,0.8in)»

or

«IncludePicture(images:Logo.jpg,2cm,2cm)»

The first measurement is the width, and the second is the height of the picture in the merged document.

If the units (‘in’ for inches and ‘cm’ for centimetres) are omitted, the default is ‘inches’.

Aspect Ratio

Regardless of the dimensions specified in the IncludePicture command, XpressDox will maintain the aspect ratio (ratio between Width and Height) of the original image. This will ensure that the image will always fit into the rectangle in the document which is defined by the Width and Height arguments in the command, but it will nonetheless maintain its original aspect ratio, and not be stretched or compressed “out of shape”.

Note that if the picture file can’t be found, then this is not regarded as an error – the command is then ignored.

The dimensions of the picture must be supplied in a format conforming to the regional settings of the computer on which the template is run. If this means that the decimal separator is a comma, for instance, then the first example would have to be «IncludePicture(images:Logo.jpg,'0,8in','0,8in')». If a template is to be run from the same location but by users with different number formats for their regional settings, then it should be run for the first time by a user with the “correct” regional settings for the number format used in the template. See Understanding XpressDox Artefacts for an explanation.