ReportMagic

[Web.Html:]

Inserts HTML from a web page or from direct content.

Purpose

Inserts HTML from a web page (using url and xPath) or renders HTML directly from a content parameter.

Compatibility

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

Updates

6 months ago · January 2026

Added the 'content' parameter for direct HTML content rendering.

Parameters (15)

Grouped View

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

Filtering & Sorting (1)

Parameter	Type	Presence	Purpose	Options	Default
xPath	String	Conditional	The XPath for the web page element to extract. Required together with 'url' if 'content' is not provided. Due to the way macros are specified, XPath square brackets ([]) should be replaced with curly brackets ({}) and double quotes (") should be replaced with single quotes (') or backticks (`).	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
content	String	Conditional	HTML content to render directly. If provided, 'url' and 'xPath' are not required. Use back-ticks around the value if it contains special characters. This is NOT supported in PowerPoint (which does not support HTML rendering).	N/A	N/A
url	String	Conditional	The URL that provides the HTML source. Required together with 'xPath' if 'content' is not provided.	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
userAgent	String	Optional	An optional User Agent string to send with the HTTP request. Only used when 'url' is provided. Some websites may require this to be set.	N/A	N/A

Examples (3)

Example 1

Inserts HTML from a variable containing HTML content:

[Web.Html: content={=HtmlSnippet}]

Example 2

Inserts HTML contained in the main article on Wikipedia's United Nations page:

[Web.Html: url="https://en.wikipedia.org/wiki/United_Nations", xPath="//*{@id=`mw-content-text`}"]

Example 3

Insert the HTML specified by the content parameter:

[: `<div style="" dir="auto" data-top-level="true"><p style="margin:0;">These are custom purchase <u>terms</u>.</p><p style="margin:0;">These are custom purchase terms.</p><p style="margin:0;"><strong>These</strong> <strong>are custom purchase terms.</strong></p><p style="margin:0;"><strong>These are custom purchase terms.</strong></p><ul><li><p style="margin:0;">These are <em>custom</em> purchase terms</p></li><li><p style="margin:0;">These are custom purchase terms</p></li></ul></div>`, =>HtmlSnippet]
[Web.Html: content={=HtmlSnippet}]

Purpose

Compatibility

Updates

Examples (3)

Example 1

Example 2

Example 3

Search

Reconnection

Reconnection

Reconnection