MacroProcessingContext Class

Context for macro processing (context for parsing the text for macro expressions).

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroProcessingContext

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

Syntax

public class MacroProcessingContext

The MacroProcessingContext type exposes the following members.

Constructors

	Name	Description
Public method	MacroProcessingContext

Methods

	Name	Description
Public method	GetWholeMacroExpression	Returns the whole version of the expression created by concatenation of the parameters. The result is for example this: {(0)%test%(0)}.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	BracketType	Type of the baracket - used for backward compatibility when macros could be nested '{(0)% %(0)}'
Public property	Expression	Identified macro expression including all the parameters.
Public property	IsOpenExpression	Indicates whether the expression is transformed open expression (condition, loop).
Public property	MacroEnd	End of the macro (position after end bracket).
Public property	MacroStart	Start position of the macro (position of starting bracket).
Public property	MacroType	Type of the macro ($, %, #, etc.).
Public property	Parameter	Custom object parameter passed to the processing handler.
Public property	Replacement	Replacement string passed to the macro handler.
Public property	SourceText	Text in which the macro was found.