ReportMagic

[If:]

Conditionally process a section of the input document.

Compatibility

The macro can be used in all input document types and in Report Studio.

Usage

	[If:condition=<condition>]
		<Section of document to optionally include if the condition is true>
	[EndIf:]

...or...

	[If: condition=<condition>]
		<Section of document to optionally include if the condition IS true>
	[Else: ]
		<Section of document to optionally include if the condition IS NOT true>
	[EndIf: ]

...or...

	[If: condition=<condition 1>]
		<Section of document to optionally include if condition 1 is true>
	[ElseIf: condition=<condition 2>]
		<Section of document to optionally include if condition 2 is true>
	[Else: ]
		<Section of document to optionally include if neither condition is true>
	[EndIf: ]

...or...

	[If:condition=<condition 1>]<Section of document to optionally include if condition 1 is true>[ElseIf:condition=<condition 2>]<Section of document to optionally include if condition 2 is true>[EndIf:]

Notes

Unlike the examples above, try NOT including newline characters to retain full control over your formatting.

In the last example above, noting the lack of carriage returns, there is no output at all if neither condition is met.

The relational operators used in many common, C-like computer languages can be used for comparisons:

== : 'is equal to'
!= : 'is not equal to'
< : 'is less than'
> : 'is greater than'
<= : 'is less than or equal to'
>= : 'is greater than or equal to'

When comparing strings, the strings should be enclosed in single quotes. For example [If: condition=" 'A' == '{Value}' "].

[If:] macros can be nested (see examples).

All functions supported by the [Calculate:] macro are also supported by this macro.

Parameters (11)

Grouped View

Mandatory (1)

Parameter	Type	Purpose	Options	Default
condition	String	The section condition. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z'),	N/A	N/A

Behaviour (4)

Parameter	Type	Presence	Purpose	Options	Default
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	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

Filtering & Sorting (1)

Parameter	Type	Presence	Purpose	Options	Default
condition	String	Mandatory	The section condition. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z'),	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
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	ExecutionResult	Optional	If specified, asserts the expected execution result of the macro. The macro executes normally; if the actual result matches the desired value, 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

Examples (11)

Example 1

[If: condition=1>2]The first condition is true. 1 is larger than 2.[Else: ]The condition is false. 1 is actually smaller than 2.[EndIf:]

Outputs: The condition is false. 1 is actually smaller than 2.

Example 2

[If: condition=1>2]The condition is true. 1 is a larger than 2.[ElseIf: condition=1<3]The second condition is true. 1 is smaller than 3.[EndIf:]

Outputs: The second condition is true. 1 is smaller than 3.

Example 3

[If: condition=1>2]The first condition is true. 1 is larger than 2[ElseIf: condition=1>3]The second condition is true. 1 is smaller than 3.[Else: ]Both conditions are false. 1 is not larger than 2 or 3.[EndIf:]

Outputs: Both conditions are false. 1 is not larger than 2 or 3

Example 4

Does ABC contain the letter B?

[If: condition="contains('ABC', 'B')"]Yes, ABC contains the letter B.[Else:]No, ABC does not contain the letter B.[EndIf:]

Outputs: Yes, ABC contains the letter B.

Example 5

Does ABC contains the letter Z?

[If: condition="contains('ABC', 'Z')"]Yes, ABC contains the letter Z.[Else:]No, ABC does not contain the letter Z.[EndIf:]

Outputs: No, ABC does not contain the letter Z.

Example 6

Does ABC start with the letter A?

[If: condition="startsWith('ABC', 'A')"]Yes, ABC starts with the letter A.[Else:]No, ABC does not start with the letter Z.[EndIf:]

Outputs: Yes, ABC starts with the letter A.

Example 7

Does ABC end with the letter A?

[If: condition="endsWith('ABC', 'A')"]Yes, ABC ends with the letter A.[Else:]No, ABC does not end with the letter A.[EndIf:]

Outputs: No, ABC does not end with the letter A.

Example 8

Does ABC end with the letter A or C?

[If: condition="endsWith('ABC', 'A')"]Yes, ABC ends with the letter A.[ElseIf: condition="endsWith('ABC', 'C')"]Yes, ABC ends with the letter C.[Else:]Both conditions failed. ABC does not end with A or C.[EndIf: ]

Outputs: Yes, ABC ends with the letter C.

Example 9

Does 5 + (does 1 = 2 ? if so, choose 3, otherwise choose 4) equal 9? Note the first statement has a conditional if, testing whether 1 equals 2 (no) so falling back to 4, so the first If statement then becomes '5 + 4 = 9'.

[If: condition="5 + if(1=2, 3, 4) = 9"]Yes, the sum of 5 + 4 = 9.[Else:]No, the sum of 5 + 4 is not 9.[EndIf:]

Outputs: Yes, the sum of 5 + 4 = 9.

Example 10

Test whether a variable, previously generated via a String macro, ends with a certain character. Note that variables can be referenced directly in a condition clause without curly brackets.

[String: value=JKL, storeAsHidden=X][If: condition="endsWith(X, 'L')"]Yes, JKL ends with the letter L.[EndIf:]

Outputs: Yes, JKL ends with the letter L.

Example 11

A nested If example:

[If: condition=2>1]2 is larger than 1.[If: condition=4>3] And 4 is larger than 3.[EndIf:][EndIf:]

Outputs: 2 is larger than 1. And 4 is larger than 3.

Compatibility

Usage

Notes

Examples (11)

Example 1

Example 2

Example 3

Example 4

Example 5

Example 6

Example 7

Example 8

Example 9

Example 10

Example 11

Search