MacroProcessor Class

Class providing general macro processing methods.

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroProcessor

Namespace: CMS.MacroEngine
Assembly: CMS.MacroEngine (in CMS.MacroEngine.dll) Version: 12.0.0

Syntax

public static class MacroProcessor

The MacroProcessor type exposes the following members.

Fields

	Name	Description
Public field Static member	NOT_RESOLVE	Defines a replacement constant for macro processing to not resolve the macro at all
Public field Static member	XMLColumns	List of XML columns needed for signing the macros.

Methods

	Name	Description
Public method Static member	BuildMacroParameter(MacroIdentityOption)	Builds macro parameter from identity option.
Public method Static member	BuildMacroParameter(String, String)	Builds the macro parameter.
Public method Static member	ContainsMacro	Returns true if the specified text contains macro.
Public method Static member	DecodeMacros	HTML decodes macro definitions for given text.
Public method Static member	EncodeMacro	Encodes macro to prevent its resolving.
Public method Static member	EscapeParameterValue	Escapes the parameter value (ensures nested macros within the parameter values are escaped).
Public method Static member	GetMacros	Gets the list of macros in the given text.
Public method Static member	IsLocalizationMacro	Returns true if given text is in {$xxx$} format. Note that this method returns true only if the whole text is localization macro, it is NOT a contains method.
Public method Static member	IsXMLColumn	Returns true, if the given column is a XML column
Public method Static member	ProcessDataMacros	Replaces data macros with given replacement or resolves them if replacement is null.
Public method Static member	ProcessMacros	Replaces macros with given replacement or resolves them if replacement is null.
Public method Static member	RemoveDataMacroBrackets	Removes data macro brackets {% %} from given text.
Public method Static member	RemoveLocalizationMacroBrackets	Removes localization macro brackets {$ $} from given text.
Public method Static member	RemoveMacroBrackets	Removes all types macro brackets from given text.
Public method Static member	RemoveMacros	Removes macros from input text. Macros are replaced by specified replacement.
Public method Static member	RemoveParameter(String, String)	Removes parameter with given name from macro expression (expression should be without brackets {%%}).
Public method Static member	RemoveParameter(String, String, String)	Removes parameter with given name from macro expression (expression should be without brackets {%%}).
Public method Static member	RemoveQueryMacroBrackets	Removes query macro brackets {? ?} from given text.
Public method Static member	UnescapeParameterValue	Un escapes the parameter value.