ReportMagic

[File.Image:]

Inserts an image from a file.

Purpose

Inserts a file image into the report.

Compatibility

The macro can be used in the highlighted input document types only. A greyed-out icon indicates not supported.

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.

Parameters (33)

Grouped View

Mandatory (1)

Parameter	Type	Purpose	Options	Default
fileName	String	The file name.	N/A	N/A

Behaviour (5)

Parameter	Type	Presence	Purpose	Options	Default
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
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 theObject, 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
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

Formatting (19)

Parameter	Type	Presence	Purpose	Options	Default
imageHeightCm	Double	Conditional	The image height in centimetres. If set, then 'imageWidthCm' must also be.	N/A	N/A
imageHeightPx	Int32	Conditional	The image height in pixels. If set, then 'imageWidthPx' 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
imageWidthPx	Int32	Conditional	The image width in pixels. If set, then 'imageHeightPx' 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
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
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. This overrides the pixel and centimetre width and height parameters.	From 0 to 300	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
wrapping	Wrapping	Optional	Image wrapping.	Inline BehindText	Inline

Output (1)2 additional

Parameter	Type	Presence	Purpose	Options	Default
fileName	String	Mandatory	The file name.	N/A	N/A

Additional (2)

Parameter	Type	Presence	Purpose	Options	Default
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
failureVariable	String	Optional	The name of a variable to create should the macro fail to execute. The variable will be a text variable, and will contain either the failure text (only if the failureText parameter is set), otherwise it will contain the exception / failure message.	N/A	N/A

General (2)4 additional

Parameter	Type	Presence	Purpose	Options	Default
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
title	String	Optional	The image title for visually-impaired users.	N/A	N/A

Additional (4)

Parameter	Type	Presence	Purpose	Options	Default
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
desiredExecutionResult	ExecutionResult	Optional	If specified, asserts the expected execution result of the macro. The macro executes normally; if the actual result matches the desired value, the result is converted to Success. If the actual result does not match, the result is converted to MacroError with a descriptive message. This is primarily used for testing and diagnostic purposes. Valid values are: Unknown, Success, MacroError, WorkerStopped, Running, Warning, NeverRun, Cancelled, Pending, Paused, SystemError, Deferred, Stopped.	Cancelled Deferred MacroError NeverRun Paused Pending Running Stopped Success SystemError Warning WorkerStopped	N/A
expectedType	String	Optional	If specified, asserts the expected output type of the macro result. The macro executes normally; if the actual type does not match, a macro error is generated. Requires 'storeAs', 'storeAsHidden', or 'storeFormattedValueAs' to be set for typed validation. Valid types include CLR names (e.g. Int32, Int64, Single, Double, Boolean, String, JArray, JObject) and C# keyword aliases (e.g. int, long, float, double, bool, string, uint, ulong, short, ushort, byte, sbyte, decimal, char, object). The special value 'Number' matches any numeric type.	N/A	N/A
expectedValue	String	Optional	If specified, asserts the expected output value of the macro result. The macro executes normally; if the actual value does not match, a macro error is generated. When 'storeAs' or 'storeAsHidden' is set, the stored variable value is compared. Otherwise, the document output text is compared.	N/A	N/A

Examples (1)

Example 1

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

Purpose

Compatibility

Usage

Examples (1)

Example 1

Search