Table of Contents

Interface IMacroMethod

Namespace
CMS.Core
Assembly
CMS.Core.dll

Represents method executable in MacroEngine.

public interface IMacroMethod
Extension Methods

Properties

Comment

Gets or sets a comment for the method.

string Comment { get; set; }

Property Value

string

IsHidden

If true, the method won't be visible in IntelliSense (but will be normally executed when called).

bool IsHidden { get; set; }

Property Value

bool

IsObsolete

Indicates whether method is obsolete.

bool IsObsolete { get; set; }

Property Value

bool

Method

Gets or sets reference to a method.

Func<object[], object> Method { get; set; }

Property Value

Func<object[], object>

MinimumParameters

Gets or sets the minimal number of parameters needed by the method.

int MinimumParameters { get; set; }

Property Value

int

MovedFromNamespace

Original namespace the method was moved from. The method usage with the specified namespace is considered as obsolete.

string MovedFromNamespace { get; set; }

Property Value

string
See Also

Name

Returns name of the method.

string Name { get; set; }

Property Value

string

ObsoleteMessage

The message that describes alternative workarounds.

string ObsoleteMessage { get; set; }

Property Value

string

Parameters

Gets or sets the parameters for the method.

List<IMacroMethodParam> Parameters { get; set; }

Property Value

List<IMacroMethodParam>

Snippet

Gets or sets a code snippet which is used in AutoCompletion when TAB is pressed (for determining the cursor position use pipe).

string Snippet { get; set; }

Property Value

string

SpecialParameters

Gets or sets the list of special parameters needed to be supplied by resolver.

string[] SpecialParameters { get; set; }

Property Value

string[]

Type

Gets or sets a return type of the method.

Type Type { get; set; }

Property Value

Type

Methods

AddParameter(string, Type, string, bool, bool)

Adds parameter to the method definition.

void AddParameter(string name, Type type, string comment, bool isParams = false, bool asExpression = false)

Parameters

name string

Name of the parameter

type Type

Type of the parameter

comment string

Comment of the parameter

isParams bool

If true, parameter is declared with params keyword

asExpression bool

If true, the parameter is passed to the method as expression (MacroExpression object), not evaluated

ExecuteMethod(params object[])

Executes given method with parameters.

object ExecuteMethod(params object[] parameters)

Parameters

parameters object[]

Method parameters

Returns

object