---

Macro Compatibility

---

Usage

NOTE: the text on a shape is set as a single, centred paragraph using the theme's standard colour. If you want to change this, then use the [Shape.Format:] macro after setting the text, for example to change its colour or font size. For more information on using macros in PowerPoint, see: PowerPoint help.

---

Parameter	Type	Presence	Purpose	Options	Default
value	String	Mandatory	The text value to set in the shape.	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
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
ids	List<String>	Optional	Specify the ID or IDs of the shapes to set text for (affects shapes on the current slide by default, but you can change the 'Scope' parameter). If IDs are not provided, the macro must be in the main text or Alt Text of the shapes to use, but when IDs are used it can be anywhere (Notes, shape text, or Alt Text of a shape). Special case: line shapes are unaffected - simply because they have no text. To edit a shape's Alt Text, right-click on the shape then choose View Alt Text to open the edit panel. NOTE: shape IDs do not need to be unique, i.e. you could set the same ID on multiple shapes, such as SHAPES_TO_SET_TEXT_FOR.	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
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
scope	PowerPointScopeType	Optional	Whether to hide shapes found on the current slide only, or those anywhere in the presentation. Only has an effect when the 'ids' parameter is used, as otherwise the containing shape is hidden.	Slide Presentation	Slide
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 (1)

Example 1:

Clones a shape then sets its text:

[Shape.Clone:ids=SHAPE_TO_CLONE, cloneId=CLONED_SHAPE]
[Shape.SetText:ids=CLONED_SHAPE, value=This is the new text!]