MacroField Class

Wrapper for any macro data field (source).

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroExtension
    CMS.MacroEngine.MacroField

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

Syntax

public class MacroField : MacroExtension

The MacroField type exposes the following members.

Constructors

	Name	Description
Public method	MacroField(String, Func<Object>, Func<EvaluationContext, Boolean>)	Creates new instance with value evaluator which does not need a context.
Public method	MacroField(String, Func<EvaluationContext, Object>, Func<EvaluationContext, Boolean>)	Creates new instance with value evaluator which needs a context.

Methods

	Name	Description
Public method	GetValue	Returns the value of the field in the given evaluation context.
Public method	IsFieldAvailable	Returns true if the field is available in the given context.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	Name	Returns name of the field. (Inherited from MacroExtension.)