ReportMagic

[Shape.SetText:]

Sets the text on a shape (PowerPoint only).

Compatibility

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

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.

Parameters (14)

Grouped View

Mandatory (1)

Parameter	Type	Purpose	Options	Default
value	String	The text value to set in the shape.	N/A	N/A

Behaviour (8)

Parameter	Type	Presence	Purpose	Options	Default
desiredExecutionResult	List<ExecutionResult>	Optional	If specified, asserts the expected execution result of the macro. Accepts a single value or a semicolon-separated list of acceptable values (e.g. 'Success;Warning'). The macro executes normally; if the actual result matches any of the desired values, 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' and 'Stopped'.	Cancelled Deferred MacroError NeverRun Paused Pending Running Stopped Success SystemError Warning WorkerStopped	N/A
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
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
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

Output (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 (4)

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
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
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

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!]

Compatibility

Usage

Examples (1)

Example 1

Search

Reconnection

Reconnection

Reconnection