Class MacroMethods

Namespace

CMS.MacroEngine

Assembly

CMS.MacroEngine.dll

Macro methods.

public class MacroMethods : CoreMethods

Inheritance

object

CoreMethods

MacroMethods

Inherited Members

CoreMethods.GetString(string, string)

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Fields

mAnyTypeMethods

List of methods which are available for any type

protected static List<MacroMethod> mAnyTypeMethods

Field Value

List<MacroMethod>

mMethods

Table of available methods.

protected static SafeDictionary<string, MacroMethod> mMethods

Field Value

SafeDictionary<string, MacroMethod>

mMethodsByType

Index of methods available for specified type.

protected static SafeDictionary<Type, List<MacroMethod>> mMethodsByType

Field Value

SafeDictionary<Type, List<MacroMethod>>

Properties

Methods

Gets the hashtable with all methods.

public static SafeDictionary<string, MacroMethod> Methods { get; }

Property Value

SafeDictionary<string, MacroMethod>

Methods

AreMethodsRegistered()

Returns true if methods are registered in the hashtable of all methods.

public static bool AreMethodsRegistered()

Returns

bool

ExecuteMethod(string, MacroResolver, params object[])

Executes the given method with parameters.

public static object ExecuteMethod(string name, MacroResolver resolver, params object[] parameters)

Parameters

name string

Method name

resolver MacroResolver

Resolver object

parameters object[]

Method parameters

Returns

object

ExecuteMethod(string, params object[])

Executes the given method with parameters.

public static object ExecuteMethod(string name, params object[] parameters)

Parameters

name string

Method name

parameters object[]

Method parameters

Returns

object

GetMethod(string)

Gets the specific method delegate.

public static MacroMethod GetMethod(string name)

Parameters

name string

Method name

Returns

MacroMethod

GetMethodsForObject(object)

Returns the list of macro methods suitable for specified object.

public static List<MacroMethod> GetMethodsForObject(object obj)

Parameters

obj object

Object for which the list should be returned

Returns

List<MacroMethod>

GetMethodsForObject(object, bool)

Returns the list of macro methods suitable for specified object.

public static List<MacroMethod> GetMethodsForObject(object obj, bool includeAnyTypeMethods)

Parameters

obj object

Object for which the list should be returned

includeAnyTypeMethods bool

If true, methods for any type are included as well

Returns

List<MacroMethod>

GetMethodsForObject(object, bool, bool)

Returns the list of macro methods suitable for specified object.

public static List<MacroMethod> GetMethodsForObject(object obj, bool includeAnyTypeMethods, bool exactType)

Parameters

obj object

Object for which the list should be returned

includeAnyTypeMethods bool

If true, methods for any type are included as well

exactType bool

If true only methods with exactly the same type are returned (= no inherited members)

Returns

List<MacroMethod>

RegisterMethod(MacroMethod)

Registers the given method within the method table.

public static void RegisterMethod(MacroMethod method)

Parameters

method MacroMethod

Macro method to register

RegisterMethodInternal(string, Func<EvaluationContext, object[], object>, Type, string, int, object[,], string[], List<Type>)

Registers the given method within the method table.

protected static void RegisterMethodInternal(string name, Func<EvaluationContext, object[], object> method, Type type, string comment, int minimumParameters, object[,] parameterDefinition, string[] specialParameters, List<Type> allowedTypes)

Parameters

name string

Method name

method Func<EvaluationContext, object[], object>

Method delegate

type Type

Return type of the method

comment string

Comment for the method

minimumParameters int

Minimal number of parameters needed to call the method

parameterDefinition object[,]

Parameter definition in format {{name, type, comment}, {name, type, comment}}

specialParameters string[]

A list of special parameters needed to be supplied by resolver

allowedTypes List<Type>

List of types for which the method is applicable (set to null for all types to be allowed)

RegisterMethodInternal(string, Func<MacroResolver, object[], object>, Type, string, int, object[,], string[], List<Type>)

Registers the given method within the method table.

protected static void RegisterMethodInternal(string name, Func<MacroResolver, object[], object> method, Type type, string comment, int minimumParameters, object[,] parameterDefinition, string[] specialParameters, List<Type> allowedTypes)

Parameters

name string

Method name

method Func<MacroResolver, object[], object>

Method delegate

type Type

Return type of the method

comment string

Comment for the method

minimumParameters int

Minimal number of parameters needed to call the method

parameterDefinition object[,]

Parameter definition in format {{name, type, comment}, {name, type, comment}}

specialParameters string[]

A list of special parameters needed to be supplied by resolver

allowedTypes List<Type>

List of types for which the method is applicable (set to null for all types to be allowed)

RegisterMethodInternal(string, Func<object[], object>, Type, string, int, object[,], string[], List<Type>)

Registers the given method within the method table.

protected static void RegisterMethodInternal(string name, Func<object[], object> method, Type type, string comment, int minimumParameters, object[,] parameterDefinition, string[] specialParameters, List<Type> allowedTypes)

Parameters

name string

Method name

method Func<object[], object>

Method delegate

type Type

Return type of the method

comment string

Comment for the method

minimumParameters int

Minimal number of parameters needed to call the method

parameterDefinition object[,]

Parameter definition in format {{name, type, comment}, {name, type, comment}}

specialParameters string[]

A list of special parameters needed to be supplied by resolver

allowedTypes List<Type>

List of types for which the method is applicable (set to null for all types to be allowed)