---

Macro Compatibility

---

Usage

Does nothing in Report Studio, or when the output document format is HTML or PDF. To view custom properties in your Word document, from the File menu, click Info. From the Properties drop down, click Advanced Properties then in the dialog box that appears, click the Custom tab.

---

Parameter	Type	Presence	Purpose	Options	Default
author	String	Optional	Sets the Author property of a Word document.	N/A	N/A
category	String	Optional	Sets the Category property of a Word document.	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
company	String	Optional	Sets the Company property of a Word document.	N/A	N/A
customProperties	List<String>	Optional	Sets the Custom Properties of a Word document. The format to use is as follows (failure to do so simply skips the property): Prop 1 Name^Prop 1 Value;Prop 2 Name;Prop 2 Value;Prop N Name^Prop N Value;...	N/A	N/A
description	String	Optional	Sets the Description (or Comments) property of a Word document.	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
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
keywords	String	Optional	Sets the Keywords property of a Word document.	N/A	N/A
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
status	String	Optional	Sets the Status property of a Word document.	N/A	N/A
subject	String	Optional	Sets the Subject property of a Word document.	N/A	N/A
title	String	Optional	Sets the Title property of a Word document.	N/A	N/A
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

---

Examples (2)

Example 1:

Sets various properties of a Word document:

[Document.SetProperties: author=The Author, title=My Title, description=My Description, status=Released]

---

Example 2:

Sets various custom properties of a Word document:

[Document.SetProperties: customProperties=Prop 1 Name^Prop 1 Value;Prop 2 Name^Prop 2 Value]