---

Purpose

Performs a case-sensitive "Search and Replace". Can be global (default) or can be limited to just the previous table. As with other macros, these are run in the order they appear in the template, so may affect each other. Note that the contents of the report at the time the macro is run are considered.

---

Macro Compatibility

---

Parameter	Type	Deprecation Message	Preferred Parameter	Presence	Purpose	Options	Default
find	String			Mandatory	Text to find. Must be specified and cannot be empty.	N/A	N/A
replaceWith	String			Mandatory	Text to replace it with. Must be specified, but may be empty. To replace text with a double quote ("), use DOUBLEQUOTE.	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
condition	String	Deprecated	if		An optional condition that must be true in order for the macro to execute. See [If:] macro for more information.	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
if	String	Use instead of: condition		Optional	An optional condition that must be true in order for the macro to execute. See [If:] macro for more information.	N/A	N/A
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
scope	String			Optional	Whether to search and replace in the entire document or just the previous table	document previousTable	document
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 (5)

Example 1:

[SearchAndReplace: find=Total Logins, replaceWith=Login attempts]

---

Example 2:

Search and replace only in the previous table:

[SearchAndReplace: find=Total Logins, replaceWith=Login attempts, scope=previousTable]

---

Example 3:

Search and replace using the condition parameter and a table - note that you must put the first 2 lines below into a table:

[String: value=True, storeAsHidden=PleaseReplaceItems]
Router1 is here!
[SearchAndReplace: find=Router, replaceWith=Switch, scope=previousTable, if="'{PleaseReplaceItems}' == 'True' "]

---

Example 4:

Search and replace using the condition parameter:

[String: value=True, storeAsHidden=PleaseReplaceItems]
Router1 is here!
[SearchAndReplace: find=Router, replaceWith=Switch, if="'{PleaseReplaceItems}' == 'True' "]

---

Example 5:

Search and replace using an If/Else macro and condition parameter:

[String: value=Total Logins, storeAs=X] [SearchAndReplace: find=Total Logins, replaceWith=Login attempt] [If: condition="endsWith(X, 't')"]Yes.[Else:] no [EndIf:]