Click or drag to resize
MacroMethod Class
Macro method object.
Inheritance Hierarchy

Namespace: CMS.MacroEngine
Assembly: CMS.MacroEngine (in CMS.MacroEngine.dll) Version: 10.0.0
Syntax
C#
public class MacroMethod : MacroExtension, 
	IMacroMethod

The MacroMethod type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAllowedTypes
Gets or sets a list of types for which the method is applicable (set to null for all types to be allowed).
Public propertyComment
Gets or sets a comment for the method.
Public propertyIsHidden
If true, the method won't be visible in IntelliSense (but will be normally executed when called).
Public propertyMethod
Gets or sets reference to a method.
Public propertyMethodContext
Gets or sets reference to a method.
Public propertyMethodResolver
Gets or sets reference to a method.
Public propertyMinimumParameters
Gets or sets the minimal number of parameters needed by the method.
Public propertyName
Returns name of the field.
(Inherited from MacroExtension.)
Public propertyParameters
Gets or sets the parameters for the method.
Public propertySnippet
Gets or sets a code snippet which is used in AutoCompletion when TAB is pressed (for determining the cursor position use pipe).
Public propertySpecialParameters
Gets or sets the list of special parameters needed to be supplied by resolver.
Public propertyType
Gets or sets a return type of the method.
Top
Methods
  NameDescription
Public methodAddParameter(IMacroMethodParam)
Adds parameter to the method definition.
Public methodAddParameter(String, Type, String, Boolean, Boolean)
Adds parameter to the method definition.
Public methodExecuteMethod(Object)
Executes given method with parameters.
Public methodExecuteMethod(EvaluationContext, Object)
Executes given method with parameters.
Public methodGetParameterComment
Returns a comment of the index-th parameter.
Public methodGetParameterName
Returns a name of the index-th parameter.
Public methodGetParameterType
Returns a type of the index-th parameter.
Top
See Also