Breaks out of a [ForEach:] or [While:] loop.
Purpose
Breaks out of a [ForEach:] or [While:] loop, and uses a similar structure to traditional "break" syntax in common programming languages. When loops are nested, it breaks out of the innermost one. Typically used in conjunction with an [If:] macro.
Compatibility
The macro can be used in all input document types and in Report Studio.
Updates
A [Break:] in a [Case:] or [Default:] of a [Switch:] no longer reports that it must be inside a loop: as in 4.5, it is removed without its condition being checked.
History (3)
A [Break:] that is not inside a [ForEach:] or [While:] loop now reports an error, instead of silently doing nothing.
When [While:] and [ForEach:] loops are nested inside each other, a [Break:] or [Continue:] in the inner loop now works instead of failing with a 'guid' macro parameter error.
Now supports the condition parameter.
Behaviour (8)
| Parameter | Type | Presence | Purpose | Options | Default |
| 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'. |
|
N/A | |
| Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |
| 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 | |
| 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 | |
| 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 | |
| MacroMode | Optional | The mode in which variables are stored. In legacy mode (default for Schedules), the variable created is a string and formatted. In normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a JArray etc., rather than a formatted string. |
|
Legacy | |
| 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 | |
| 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 |
| 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 | |
| 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 |
Examples (2)
Example 1
A simple Break statement used within a [ForEach:] and an [If:] macro (indents are used for readability but are not necessary): The expected output is: Number is: 0 Number is: 1 Number is: 2
[String:value=0;1;2;3;4;5;6;7;8;9, storeAsHidden=numbers]
[ForEach:storeAs=number, values={numbers}]
[If:condition='{number}' == '3']
[Break:comment=If we get to 3 break out of loop]
[EndIf:]
Number is: [String:value={number}]
[EndForEach:]Example 2
The same functionality as the first example, but without requiring the If statement. Instead, the Break macro uses the 'condition' parameter to achieve the same thing:
[String:value=0;1;2;3;4;5;6;7;8;9, storeAsHidden=numbers]
[ForEach:storeAs=number, values={numbers}]
[Break:comment=If we get to 3 break out of loop, condition='{number}' == '3']
Number is: [String:value={number}]
[EndForEach:]
