---

Purpose

Inserts a file image into the report.

---

Macro Compatibility

---

Usage

The fileName parameter:

• should reference an image in the same folder as the report template.
• must not start with '/'.
• must not contain '..'.

Accessing subfolders is not supported.

The following file formats are supported:

• .bmp (though not recommended, due to increased output file sizes)
• .gif
• .jpg / .jpeg
• .png
• .svg

Note, in order to produce images of the highest quality in your reports, ensure you have done the following:

• In Word, from the File menu, click Options then click Advanced
• Under Image Size and Quality, from the drop down, select either the document or All New Documents
• Clear the 'Do not compress images in file' checkbox

Turning off picture compression improves picture quality, but uncompressed pictures can result in large file sizes.

Note: when you use this macro to insert an image into a PowerPoint shape, you can then use the [Shape.Format:] macro to change the position, size, and other properties.

---

Parameter	Type	Presence	Purpose	Options	Default
fileName	String	Mandatory	The file name.	N/A	N/A
imageHeightCm	Double	Conditional	The image height in centimetres. If set, then 'imageWidthCm' must also be.	N/A	N/A
imageWidthCm	Double	Conditional	The image width in centimetres. If set, then 'imageHeightCm' must also be.	N/A	N/A
clipBottom	Double	Optional	The number of pixels to clip from the bottom.	N/A	N/A
clipLeft	Double	Optional	The number of pixels to clip from the left.	N/A	N/A
clipRight	Double	Optional	The number of pixels to clip from the right.	N/A	N/A
clipTop	Double	Optional	The number of pixels to clip from the top.	N/A	N/A
comment	String	Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
description	String	Optional	The description for visually-impaired users. This text also displays when the user hovers the mouse over the image in Word or a PDF viewer.	N/A	N/A
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
failureText	String	Optional	The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message.	N/A	N/A
hAlign	PowerPointImageHorizontalAlign	Optional	For PowerPoint only, the ability to horizontally align images produced by macros, with vertical lines.	Center Left Right	N/A
horizontalPositionAlignment	HorizontalPositionAlignment	Optional	The horizontal position alignment.	Left Inline Center Right Inside Outside	Left
horizontalPositionRelativeTo	HorizontalPositionRelativeTo	Optional	What the horizontal position is relative to.	Inline Margin Column Page InsideMargin OutsideMargin LeftMargin RightMargin	Inline
if	String	Optional	The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z').	N/A	true
mode	MacroMode	Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
obfuscation	ObfuscationType	Optional	Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen.	None UkTown DeviceName Company IpAddress PrivateIpAddress	None
opacityPercent	Double	Optional	The image opacity (0 is transparent, 100 is solid).	From 0 to 100	100
pageHeightPercent	Double	Optional	The page height percentage.	From 0 to 300	N/A
pageWidthPercent	Double	Optional	The page width percentage.	From 0 to 300	N/A
title	String	Optional	The image title for visually-impaired users.	N/A	N/A
titleHeadingLevel	Int32	Optional	The title heading level. Don't specify if no heading is required.	N/A	N/A
vAlign	PowerPointImageVerticalAlign	Optional	For PowerPoint only, the ability to vertically align images produced by macros, with horizontal lines.	Bottom Middle Top	N/A
verticalPositionAlignment	VerticalPositionAlignment	Optional	The Vertical position alignment.	Top Inline Center Bottom Inside Outside	Top
verticalPositionRelativeTo	VerticalPositionRelativeTo	Optional	What the vertical position is relative to.	Inline Page Paragraph Margin BottomMargin InsideMargin OutsideMargin TopMargin	Inline
warning	String	Optional	If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression.	N/A	N/A
wrapping	Wrapping	Optional	Image wrapping.	Inline BehindText	Inline

---

Examples (1)

Example 1:

[File.Image:fileName=Logo.png, pageWidthPercent=5]