Table of Contents

Class EvaluationContext

Namespace
CMS.MacroEngine
Assembly
CMS.MacroEngine.dll

Context for macro expression evaluation. Reflects resolver settings and inline macro parameters.

public class EvaluationContext
Inheritance
object
EvaluationContext
Extension Methods

Constructors

EvaluationContext(MacroResolver, string, string)

Creates new EvaluationContext which takes the default values from resolver. Note that these can be modified during evaluation process via macro parameters.

public EvaluationContext(MacroResolver resolver, string originalExpression, string expressionType = "%")

Parameters

resolver MacroResolver

Resolver which is used for the evaluation

originalExpression string

Original expression which is being evaluated

expressionType string

Type of the expression being evaluated (% or $ or ?)

Properties

AllowOnlySimpleMacros

Determines whether only simple macros (macros which do not require security check) are allowed.

public bool AllowOnlySimpleMacros { get; set; }

Property Value

bool

CaseSensitive

Determines whether string comparison and other operations are case sensitive. False by default.

public bool CaseSensitive { get; set; }

Property Value

bool

CheckSecurity

Main setting determining whether the macro security (signatures) is checked.

public bool CheckSecurity { get; set; }

Property Value

bool

ConsoleOutput

Console output - place where the results can be written during macro evaluation using a "print" method. All child contexts share the output with the parent context (= there is only one console output).

public string ConsoleOutput { get; set; }

Property Value

string

Culture

Culture under which the expression is evaluated. Important for parsing double / datetime from string constants, etc.

public string Culture { get; set; }

Property Value

string

Remarks

The system culture is used by default.

CultureInfo

CultureInfo reflecting Culture property.

public CultureInfo CultureInfo { get; }

Property Value

CultureInfo

DefaultValue

Default value of the evaluation. Used when result of the whole macro is empty string.

public string DefaultValue { get; set; }

Property Value

string

EncapsulateMacroObjects

If true, the object will be encapsulated to its macro representations

public bool EncapsulateMacroObjects { get; set; }

Property Value

bool

Encode

Determines whether the result of the expression should be encoded or not.

public bool Encode { get; set; }

Property Value

bool

EvaluationStarted

Time when the evaluation started (needed for timeout evaluation).

public DateTime EvaluationStarted { get; set; }

Property Value

DateTime

EvaluationTimeout

Expression evaluation timeout in milliseconds (1000 ms by default). If the evaluation time of the expression exceeds this time, evaluation will be aborted and the result will be null. The evaluation abortion is then logged into event log.

public int EvaluationTimeout { get; set; }

Property Value

int

ExternalTimeoutChecker

Gets or sets the function used as timeout watchdog besides EvaluationTimeout setting. Returns true if timeout has occurred.

public Func<bool> ExternalTimeoutChecker { get; set; }

Property Value

Func<bool>

HandleSQLInjection

Determines whether the apostrophes in the result will be doubled to handle SQL injection.

public bool HandleSQLInjection { get; set; }

Property Value

bool

IdentityName

Gets or sets the macro identity name against which the security is checked.

public string IdentityName { get; set; }

Property Value

string

IntegrityPassed

Determines whether the security parameters are consistent with the evaluated macro.

public bool IntegrityPassed { get; }

Property Value

bool

OriginalExpression

Gets or sets the expression which is being evaluated.

public string OriginalExpression { get; set; }

Property Value

string

OriginalExpressionType

Gets or sets the type of the expression which is being evaluated (% or $ or ?).

public string OriginalExpressionType { get; set; }

Property Value

string

Recursive

Determines whether the macros in the result should be resolved as well.

public bool Recursive { get; set; }

Property Value

bool

RelatedObject

Related object allows set object used for resolving in macro method. Used in web part properties.

public object RelatedObject { get; set; }

Property Value

object

Resolver

Resolver which is used for the expression evaluation.

public MacroResolver Resolver { get; set; }

Property Value

MacroResolver

ResolverName

Gets or sets the name of the resolver which can resolve this macro (reflects inline |(resolver) parameter).

public string ResolverName { get; set; }

Property Value

string

User

Gets the user associated with this context (based on the IdentityName and UserName)

public IUserInfo User { get; }

Property Value

IUserInfo

UserName

Gets or sets the username against which the security is checked.

public string UserName { get; set; }

Property Value

string

Methods

AddInnerSource(params object[])

Adds inner source(s) to this instance of the context.

public void AddInnerSource(params object[] sources)

Parameters

sources object[]

Source(s) to add

AddPrioritizedInnerSource(params object[])

Adds prioritized inner source(s) to this instance of the context.

public void AddPrioritizedInnerSource(params object[] sources)

Parameters

sources object[]

Source(s) to add

ClearInnerSources()

Clears all inner sources (does not clear parent inner sources).

public void ClearInnerSources()

ClearPrioritizedInnerSources()

Clears all prioritized inner sources (does not clear parent inner sources).

public void ClearPrioritizedInnerSources()

CreateChildContext()

Creates child context (clones the parent settings and creates child of the resolver).

public EvaluationContext CreateChildContext()

Returns

EvaluationContext

CreateChildContext(bool)

Creates child context (clones the parent settings and creates child of the resolver).

public EvaluationContext CreateChildContext(bool createChildResolver)

Parameters

createChildResolver bool

If true, the resolver of the child context will be a child resolver of current resolver. If false, the same instance of the resolver will be used.

Returns

EvaluationContext

GetInnerSources()

Returns list of all aggregated inner sources (from the whole context hierarchy).

public List<object> GetInnerSources()

Returns

List<object>

GetPrioritizedInnerSources()

Returns list of all aggregated prioritized inner sources (from the whole context hierarchy).

public List<object> GetPrioritizedInnerSources()

Returns

List<object>