EvaluationContext Class

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

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.EvaluationContext

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

Syntax

public class EvaluationContext

The EvaluationContext type exposes the following members.

Constructors

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

Properties

	Name	Description
Public property	AllowOnlySimpleMacros	Determines whether only simple macros (macros which do not require security check) are allowed.
Public property	CaseSensitive	Determines whether string comparison and other operations are case sensitive. False by default.
Public property	CheckSecurity	Main setting determining whether the macro security (signatures) is checked.
Public property	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 property	Culture	Culture under which the expression is evaluated. Important for parsing double / datetime from string constants, etc. EN-US by default.
Public property	CultureInfo	CultureInfo reflecting Culture property.
Public property	Debug	Determines if the evaluation debugs details
Public property	DefaultValue	Default value of the evaluation. Used when result of the whole macro is empty string.
Public property	DetailedDebug	Determines if the evaluation debugs details
Public property	EncapsulateMacroObjects	If true, the object will be encapsulated to its macro representations
Public property	Encode	Determines whether the result of the expression should be encoded or not.
Public property	EvaluationStarted	Time when the evaluation started (needed for timeout evaluation).
Public property	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 property	ExternalTimeoutChecker	Gets or sets the function used as timeout watchdog besides EvaluationTimeout setting. Returns true if timeout has occurred.
Public property	HandleSQLInjection	Determines whether the apostrophes in the result will be doubled to handle SQL injection.
Public property	Hash	Gets or sets the hash against which the security is checked.
Public property	IdentityName	Gets or sets the macro identity name against which the security is checked.
Public property	IntegrityPassed	Determines whether the security parameters are consistent with the evaluated macro.
Public property	OriginalExpression	Gets or sets the expression which is being evaluated.
Public property	OriginalExpressionType	Gets or sets the type of the expression which is being evaluated (% or $ or ?).
Public property	Recursive	Determines whether the macros in the result should be resolved as well.
Public property	RelatedObject	Related object allows set object used for resolving in macro method. Used in web part properties.
Public property	Resolver	Resolver which is used for the expression evaluation.
Public property	ResolverName	Gets or sets the name of the resolver which can resolve this macro (reflects inline |(resolver) parameter).
Public property	User	Gets the user associated with this context (based on the IdentityName and UserName)
Public property	UserName	Gets or sets the username against which the security is checked.

Methods

	Name	Description
Public method	AddInnerSource	Adds inner source(s) to this instance of the context.
Public method	AddPrioritizedInnerSource	Adds prioritized inner source(s) to this instance of the context.
Public method	ClearInnerSources	Clears all inner sources (does not clear parent inner sources).
Public method	ClearPrioritizedInnerSources	Clears all prioritized inner sources (does not clear parent inner sources).
Public method	CreateChildContext()	Creates child context (clones the parent settings and creates child of the resolver).
Public method	CreateChildContext(Boolean)	Creates child context (clones the parent settings and creates child of the resolver).
Public method	GetInnerSources	Returns list of all aggregated inner sources (from the whole context hierarchy).
Public method	GetPrioritizedInnerSources	Returns list of all aggregated prioritized inner sources (from the whole context hierarchy).