Table of Contents

Class MacroProcessingContext

Namespace
CMS.MacroEngine
Assembly
CMS.MacroEngine.dll

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

public class MacroProcessingContext
Inheritance
object
MacroProcessingContext
Extension Methods

Constructors

MacroProcessingContext()

Creates a new MacroProcessingContext instance

public MacroProcessingContext()

Properties

BracketType

Type of the bracket - used for backward compatibility when macros could be nested '{(0)% %(0)}'

public string BracketType { get; set; }

Property Value

string

Expression

Identified macro expression including all the parameters.

public string Expression { get; set; }

Property Value

string

IsOpenExpression

Indicates whether the expression is transformed open expression (condition, loop).

public bool IsOpenExpression { get; set; }

Property Value

bool

MacroEnd

End of the macro (position after end bracket).

public int MacroEnd { get; set; }

Property Value

int

MacroStart

Start position of the macro (position of starting bracket).

public int MacroStart { get; set; }

Property Value

int

MacroType

Type of the macro ($, %, #, etc.).

public string MacroType { get; set; }

Property Value

string

Replacement

Replacement string passed to the macro handler.

public string Replacement { get; set; }

Property Value

string

SourceText

Text in which the macro was found.

public string SourceText { get; set; }

Property Value

string

Methods

GetMacroProcessingColumnAdapter()

Returns the column adapter that is used during processing.

public IMacroProcessingColumnAdapter GetMacroProcessingColumnAdapter()

Returns

IMacroProcessingColumnAdapter

GetOriginalExpression()

Returns macro expression demarcated by macro start and macro end in entire source text

public string GetOriginalExpression()

Returns

string

GetWholeMacroExpression()

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

public string GetWholeMacroExpression()

Returns

string