Click or drag to resize
MacroProcessor Class
Class providing general macro processing methods.
Inheritance Hierarchy
SystemObject
  CMS.MacroEngineMacroProcessor

Namespace: CMS.MacroEngine
Assembly: CMS.MacroEngine (in CMS.MacroEngine.dll) Version: 11.0.0
Syntax
C#
public static class MacroProcessor

The MacroProcessor type exposes the following members.

Fields
  NameDescription
Public fieldStatic memberNOT_RESOLVE
Defines a replacement constant for macro processing to not resolve the macro at all
Public fieldStatic memberXMLColumns
List of XML columns needed for signing the macros.
Top
Methods
  NameDescription
Public methodStatic memberBuildMacroParameter(MacroIdentityOption)
Builds macro parameter from identity option.
Public methodStatic memberBuildMacroParameter(String, String)
Builds the macro parameter.
Public methodStatic memberContainsMacro
Returns true if the specified text contains macro.
Public methodStatic memberDecodeMacros
HTML decodes macro definitions for given text.
Public methodStatic memberEncodeMacro
Encodes macro to prevent its resolving.
Public methodStatic memberEscapeParameterValue
Escapes the parameter value (ensures nested macros within the parameter values are escaped).
Public methodStatic memberGetMacros
Gets the list of macros in the given text.
Public methodStatic memberIsLocalizationMacro
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 methodStatic memberIsXMLColumn
Returns true, if the given column is a XML column
Public methodStatic memberProcessDataMacros
Replaces data macros with given replacement or resolves them if replacement is null.
Public methodStatic memberProcessMacros
Replaces macros with given replacement or resolves them if replacement is null.
Public methodStatic memberRemoveDataMacroBrackets
Removes data macro brackets {% %} from given text.
Public methodStatic memberRemoveLocalizationMacroBrackets
Removes localization macro brackets {$ $} from given text.
Public methodStatic memberRemoveMacroBrackets
Removes all types macro brackets from given text.
Public methodStatic memberRemoveMacros
Removes macros from input text. Macros are replaced by specified replacement.
Public methodStatic memberRemoveParameter(String, String)
Removes parameter with given name from macro expression (expression should be without brackets {%%}).
Public methodStatic memberRemoveParameter(String, String, String)
Removes parameter with given name from macro expression (expression should be without brackets {%%}).
Public methodStatic memberRemoveQueryMacroBrackets
Removes query macro brackets {? ?} from given text.
Public methodStatic memberUnescapeParameterValue
Un escapes the parameter value.
Top
See Also