Table of Contents

Class MacroResolver

Namespace
CMS.MacroEngine
Assembly
CMS.MacroEngine.dll

Class to resolve the macros, provides data to the resolving process.

public class MacroResolver : IMacroResolver, INotCopyThreadItem
Inheritance
object
MacroResolver
Implements
Extension Methods

Constructors

MacroResolver()

Constructor

[Obsolete("This constructor is meant for system purposes, it shouldn't be used directly. Use GetInstance instead.")]
public MacroResolver()

Fields

UNRESOLVED_RETURN_VALUE

Represents unresolved keyword.

public static readonly object UNRESOLVED_RETURN_VALUE

Field Value

object

Properties

Culture

Culture for the resolving

public string Culture { get; set; }

Property Value

string

ResolverName

Resolver name used for context specific resolving.

public string ResolverName { get; set; }

Property Value

string

Examples

The macro with resolver parameter e.g. {% CurrentUser.UserName|(resolver)CustomResolverName %} will be resolved only with the same resolver name specified in this property.

var resolver = MacroResolver.CreateChild();
resolver.ResolverName = "CustomResolverName";
var result = resolver.ResolveMacros("{% CurrentUser.UserName|(resolver)CustomResolverName %}");
See Also

Settings

Macro resolver settings.

public MacroSettings Settings { get; set; }

Property Value

MacroSettings

SourceObject

Object with source data - To pass parameters to Custom macro function.

public object SourceObject { get; set; }

Property Value

object

Methods

AddAnonymousSourceData(params object[])

Adds new anonymous data source of general type to the resolver.

public void AddAnonymousSourceData(params object[] data)

Parameters

data object[]

Data to register to the resolver

AddSourceAlias(string, string)

Adds alternative source expression.

public virtual void AddSourceAlias(string source, string expression)

Parameters

source string

Source for which the alternative expression should be created

expression string

Expression which will be evaluated if the source is not found in base data sources

CheckDataSources(string, EvaluationContext)

Checks all the data sources for the value. Returns true if given data member was found within supported data sources.

public virtual EvaluationResult CheckDataSources(string expression, EvaluationContext context)

Parameters

expression string

Data member to look for

context EvaluationContext

Evaluation context

Returns

EvaluationResult

CreateChild()

Creates new instance of MacroResolver as a child resolver that loads the data from the parent resolver by default.

public virtual MacroResolver CreateChild()

Returns

MacroResolver

Remarks

Settings are cloned from parent resolver.

EncapsulateObject(object, EvaluationContext)

Encapsulates object if needed (DataSet, DataRow, DataTable to their Container equivalent).

public static object EncapsulateObject(object obj, EvaluationContext context = null)

Parameters

obj object

Object to be encapsulated

context EvaluationContext

Evaluation context

Returns

object

FinalizeResult(object, bool, EvaluationContext)

Finalizes the result (makes the result string).

protected string FinalizeResult(object result, bool processChilden, EvaluationContext context)

Parameters

result object

Result object

processChilden bool

If true, the children get finalized as well

context EvaluationContext

Evaluation context

Returns

string

GetAnonymousSources()

Returns list of all aggregated anonymous sources (from the whole resolver hierarchy).

public List<object> GetAnonymousSources()

Returns

List<object>

GetInstance(bool)

Creates new instance of MacroResolver.

public static MacroResolver GetInstance(bool inheritFromGlobalResolver = true)

Parameters

inheritFromGlobalResolver bool

If true, the resolver will be a child of the GlobalResolver (recommended if you need full feature resolver).

Returns

MacroResolver

GetNamedSourceData(string)

Gets the named source data by the given selector.

public object GetNamedSourceData(string selector)

Parameters

selector string

Selector

Returns

object

GetObjectValue(object, int, EvaluationContext)

Gets the object value at given index (this is called when indexer [(int)] is used in the expression).

public virtual EvaluationResult GetObjectValue(object objectToCheck, int index, EvaluationContext context)

Parameters

objectToCheck object

Source object to get the index-th value from

index int

Index of the item to get

context EvaluationContext

Evaluation context

Returns

EvaluationResult

GetObjectValue(object, string, EvaluationContext)

Gets the object value of specified name.

public virtual EvaluationResult GetObjectValue(object objectToCheck, string columnName, EvaluationContext context)

Parameters

objectToCheck object

Source object to get the index-th value from

columnName string

Name of the value to get

context EvaluationContext

Evaluation context

Returns

EvaluationResult

GetSourceAlias(string)

Gets the named source data by the given selector.

public virtual string GetSourceAlias(string selector)

Parameters

selector string

Selector

Returns

string

IsDataItemAvailable(string)

Checks all the data sources for the value and returns true if the data item is registered.

public virtual bool IsDataItemAvailable(string itemName)

Parameters

itemName string

Name of the data item

Returns

bool

PostProcessResult(object, bool)

If the object is InfoObject, returns its DisplayName column (if exists).

protected object PostProcessResult(object result, bool allowEnumeration = true)

Parameters

result object

Result to process

allowEnumeration bool

If true, the process allows enumeration of the result

Returns

object

PrioritizeProperty(string)

Prioritizes a property (equivalent to using SetNamedSourceData with last parameter true).

public void PrioritizeProperty(string propertyName)

Parameters

propertyName string

Name of the property to prioritize

RegisterNamespace(IMacroNamespace, string, bool, bool)

Registers a namespace within this macro resolver

public void RegisterNamespace(IMacroNamespace ns, string name = null, bool allowAnonymous = false, bool hidden = false)

Parameters

ns IMacroNamespace

Namespace object

name string

Namespace name. If not set, the name is automatically taken from the type name of the namespace object with removed Namespace suffix.

allowAnonymous bool

If true, the namespace members are registered also as anonymous

hidden bool

If true, the namespace is hidden and doesn't show up in the Intellisense

RegisterObjectValueByIndexHandler(params GetObjectValueByIndexHandler[])

Registers GetObjectValueByName handler(s) to extend possibilities of MacroEngine to dig values from particular object types. These handlers are internally used when a property is requested out of a given object. First the default object types are checked, then all the handlers (the order of the handler evaluation is not guaranteed).

public static void RegisterObjectValueByIndexHandler(params MacroResolver.GetObjectValueByIndexHandler[] handlers)

Parameters

handlers GetObjectValueByIndexHandler[]

Handler(s) to attach

RegisterObjectValueByNameHandler(params GetObjectValueByNameHandler[])

Registers GetObjectValueByName handler(s) to extend possibilities of MacroEngine to dig values from particular object types. These handlers are internally used when a property is requested out of a given object. First the default object types are checked, then all the handlers (the order of the handler evaluation is not guaranteed).

public static void RegisterObjectValueByNameHandler(params MacroResolver.GetObjectValueByNameHandler[] handlers)

Parameters

handlers GetObjectValueByNameHandler[]

Handler(s) to attach

Resolve(string, MacroSettings)

Resolves the context macros.

public static string Resolve(string inputText, MacroSettings settings = null)

Parameters

inputText string

Text to resolve

settings MacroSettings

Macro context and settings

Returns

string

ResolveCustomMacro(string, string)

Resolves the custom macro.

public EvaluationResult ResolveCustomMacro(string baseExpression, string fullExpression)

Parameters

baseExpression string

Base expression (without the parameters)

fullExpression string

Full expression (with the parameters)

Returns

EvaluationResult

ResolveMacroExpression(ResolveExpressionSettings)

Resolves the data macro expression (expects expression without {% %} brackets).

public EvaluationResult ResolveMacroExpression(ResolveExpressionSettings settings)

Parameters

settings ResolveExpressionSettings

Settings of the resolving process

Returns

EvaluationResult

Remarks

Returns null when macro evaluation throws exception

ResolveMacroExpression(string, bool, bool, string)

Resolves the data macro expression (expects expression without {% %} brackets). Use RemoveDataMacroBrackets(string) method to remove brackets if needed.

public EvaluationResult ResolveMacroExpression(string expression, bool keepObjectsAsResult = false, bool skipSecurityCheck = false, string type = "%")

Parameters

expression string

Macro expression without {% %} brackets

keepObjectsAsResult bool

If true, when the result is InfoObject it is the result, if false, object is resolved as its displayname (for backward compatibility)

skipSecurityCheck bool

If true, security check is not performed

type string

Type of the expression (? or $ or %)

Returns

EvaluationResult

Remarks

Returns null when macro evaluation throws exception

ResolveMacros(string, MacroSettings)

Resolves all supported macro types in the given text within specified resolving context.

public virtual string ResolveMacros(string text, MacroSettings settings = null)

Parameters

text string

Input text with macros to be resolved

settings MacroSettings

Macro context to be used for resolving (if null, context of the resolver is used)

Returns

string

SetAnonymousSourceData(params object[])

Sets (replaces all existing anonymous sources) specified data source (without name) of general type to the resolver.

public void SetAnonymousSourceData(params object[] data)

Parameters

data object[]

Data to register to the resolver

Remarks

This method must not be used for GlobalResolver instance. Use AddAnonymousSourceData(params object[]) instead.

SetHiddenNamedSourceData(string, Func<EvaluationContext, object>)

Registers the named source data with late binding. Callback is called whenever the value is needed by MacroResolver.

public void SetHiddenNamedSourceData(string selector, Func<EvaluationContext, object> callback)

Parameters

selector string

Data selector

callback Func<EvaluationContext, object>

Callback function which is called to get the data

SetHiddenNamedSourceData(string, object)

Registers the named source data with late binding. Callback is called whenever the value is needed by MacroResolver.

public void SetHiddenNamedSourceData(string selector, object data)

Parameters

selector string

Data selector

data object

Data

SetNamedSourceData(MacroField, bool)

Registers given field as the named source data.

public void SetNamedSourceData(MacroField field, bool isPrioritized = true)

Parameters

field MacroField

Field to register

isPrioritized bool

If true, this item will appear at the top of AutoCompletion and ObjectTree

SetNamedSourceData(IDictionary<string, object>, bool)

Sets given name-value pairs to the resolver.

public void SetNamedSourceData(IDictionary<string, object> data, bool isPrioritized = true)

Parameters

data IDictionary<string, object>

Data to register to the resolver

isPrioritized bool

If true, this item will appear at the top of AutoCompletion and ObjectTree

SetNamedSourceData(params Hashtable[])

Sets hashtable data source to the resolver. Keys of the table are considered names of the data.

public void SetNamedSourceData(params Hashtable[] data)

Parameters

data Hashtable[]

Data to register to the resolver

SetNamedSourceData(string, object, bool)

Registers the named source data. The data can be accessed with macro {%Selector.ColumnName%}. Selector has to be in identifier format.

public void SetNamedSourceData(string selector, object data, bool isPrioritized = true)

Parameters

selector string

Data selector

data object

Data

isPrioritized bool

If true, this item will appear at the top of AutoCompletion and ObjectTree

SetNamedSourceDataCallback(string, Func<EvaluationContext, object>, bool)

Registers the named source data with late binding. Callback is called whenever the value is needed by MacroResolver.

public void SetNamedSourceDataCallback(string selector, Func<EvaluationContext, object> callback, bool isPrioritized = true)

Parameters

selector string

Data selector

callback Func<EvaluationContext, object>

Callback function which is called to get the data

isPrioritized bool

If true, this item will appear at the top of AutoCompletion and ObjectTree

Events

OnGetValue

Gets value event.

public event MacroResolver.OnGetValueEventHandler OnGetValue

Event Type

MacroResolver.OnGetValueEventHandler

OnResolveCustomMacro

Custom macro event.

public static event EventHandler<MacroEventArgs> OnResolveCustomMacro

Event Type

EventHandler<MacroEventArgs>