ReportMagic

[ReportMagic.ApplyBrand:]

Applies Tenant Branding to the output document.

Purpose

Applies Tenant branding properties (such as colors and fonts) to the output document.

Macro Compatibility

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

Usage

Use this macro to apply your organization's branding (background color, font, and color scheme) to the report (Word and PDF output documents only). Specify which properties to apply, or leave blank to apply all available branding properties.

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
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
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
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
properties	List<String>	Optional	The property or properties to apply to the output document. The logo and background image of the branding currently have no effect (but will do in future). The TenantBackgroundColor parameter sets the document's default background color (Word menu: Design \| Page Color). The TenantFontFace parameter sets the font face for the "Normal" style. Good Library Report template design will ensure that MOST font faces are inherited from Normal. The TenantFontColor parameter sets the font color for the "Normal" style. The TenantHeading1FontColor parameter sets the font color for the "Heading 1" style. The TenantHeading2FontColor parameter sets the font color for the "Heading 2" style. The TenantPrimaryColor parameter sets the font color for the "Heading 1" style UNLESS overridden by the TenantHeading1FontColor having been set. The TenantSecondaryColor parameter sets the font color for the "Heading 2" style UNLESS overridden by the TenantHeading2FontColor having been set.	TenantBackgroundColor TenantFontColor TenantFontFace TenantHeading1FontColor TenantHeading2FontColor TenantPrimaryColor TenantSecondaryColor	TenantBackgroundColor;TenantFontFace;TenantFontColor;TenantHeading1FontColor;TenantHeading2FontColor;TenantPrimaryColor;TenantSecondaryColor
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 (2)

Example 1:

Apply all the branding options:

[ReportMagic.ApplyBrand:]

Outputs:

Applies all available branding properties to the document.

Example 2:

Apply only the background color and font face:

[ReportMagic.ApplyBrand: properties=TenantBackgroundColor;TenantFontFace]