ReportMagic

[Slide.MoveTo:]

Moves the current slide to a new position within a PowerPoint document.

Purpose

Moves the current slide to a new position within a PowerPoint document (or PowerPoint slide section), based on an index.

Compatibility

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

Usage

When using PowerPoint slide sections (see: PowerPoint sections), moved slides will be placed into the correct section, or the one specified. Empty sections that remain are NOT deleted by default.For more information on using macros in PowerPoint, see: PowerPoint help.

Parameters (15)

Grouped View

Mandatory (1)

Parameter	Type	Purpose	Options	Default
index	Int32	The index (0-based) of the slide's new position.	From 0 to 2147483647	N/A

Behaviour (6)

Parameter	Type	Presence	Purpose	Options	Default
deleteEmptySections	Boolean	Optional	Once the slide has been moved, whether to delete empty slide sections.	true false	false
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

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

Parameter	Type	Presence	Purpose	Options	Default
index	Int32	Mandatory	The index (0-based) of the slide's new position.	From 0 to 2147483647	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
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, 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
indexType	IndexType	Optional	Whether to move the slide relative to the start or the end of the presentation (or slide section, when the 'sectionName' parameter is used). To move a slide to the start of the presentation: 'index=0, indexType=FromStart'. To move a slide to the end of the presentation: 'index=0, indexType=FromEnd'.	FromStart FromEnd	FromStart
sectionName	String	Optional	The section name to move the slide into. The 'index' and 'indexType' parameters then relate to the section. More details on PowerPoint sections can be found here.	N/A	N/A

Examples (3)

Example 1

Moves the current slide to the start of the presentation:

[Slide.MoveTo: index=0]

Example 2

Moves the current slide to the end of the presentation:

[Slide.MoveTo: index=0, indexType=FromEnd]

Example 3

Moves the current slide to the start of the slide section called 'My Section' (which can be anywhere in the presentation):

[Slide.MoveTo: index=0, sectionName=My Section]

Purpose

Compatibility

Usage

Examples (3)

Example 1

Example 2

Example 3

Search

Reconnection

Reconnection

Reconnection