MacroMethod Class

Macro method object.

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroExtension
    CMS.MacroEngine.MacroMethod

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

Syntax

public class MacroMethod : MacroExtension, 
	IMacroMethod

The MacroMethod type exposes the following members.

Constructors

	Name	Description
Public method	MacroMethod()	Creates new MacroMethod object.
Public method	MacroMethod(String, Func<Object[], Object>)	Creates new instance of MacroMethod object.
Public method	MacroMethod(String, Func<EvaluationContext, Object[], Object>)	Creates new instance of MacroMethod object.
Public method	MacroMethod(String, Func<MacroResolver, Object[], Object>)	Creates new instance of MacroMethod object.

Properties

	Name	Description
Public property	AllowedTypes	Gets or sets a list of types for which the method is applicable (set to null for all types to be allowed).
Public property	Comment	Gets or sets a comment for the method.
Public property	IsHidden	If true, the method won't be visible in IntelliSense (but will be normally executed when called).
Public property	IsObsolete	Indicates whether method is obsolete.
Public property	Method	Gets or sets reference to a method.
Public property	MethodContext	Gets or sets reference to a method.
Public property	MethodResolver	Gets or sets reference to a method.
Public property	MinimumParameters	Gets or sets the minimal number of parameters needed by the method.
Public property	MovedFromNamespace	Original namespace the method was moved from. The method usage with the specified namespace is considered as obsolete.
Public property	Name	Returns name of the field. (Inherited from MacroExtension.)
Public property	ObsoleteMessage	The message that describes alternative workarounds.
Public property	Parameters	Gets or sets the parameters for the method.
Public property	Snippet	Gets or sets a code snippet which is used in AutoCompletion when TAB is pressed (for determining the cursor position use pipe).
Public property	SpecialParameters	Gets or sets the list of special parameters needed to be supplied by resolver.
Public property	Type	Gets or sets a return type of the method.

Methods

	Name	Description
Public method	AddParameter(IMacroMethodParam)	Adds parameter to the method definition.
Public method	AddParameter(String, Type, String, Boolean, Boolean)	Adds parameter to the method definition.
Public method	ExecuteMethod(Object[])	Executes given method with parameters.
Public method	ExecuteMethod(EvaluationContext, Object[])	Executes given method with parameters.
Public method	GetParameterComment	Returns a comment of the index-th parameter.
Public method	GetParameterName	Returns a name of the index-th parameter.
Public method	GetParameterType	Returns a type of the index-th parameter.