MacroFieldContainer Class

Container for field extensions of an arbitrary object used by MacroEngine.

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroExtensionContainer<MacroFieldContainer, MacroField>
    CMS.MacroEngine.MacroFieldContainer

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

Syntax

public class MacroFieldContainer : MacroExtensionContainer<MacroFieldContainer, MacroField>

The MacroFieldContainer type exposes the following members.

Constructors

	Name	Description
Public method	MacroFieldContainer

Methods

	Name	Description
Protected method	GetExtension(String)	Returns a Extension of given name (return null if specified Extension does not exist). (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected method	GetExtension(Type, String)	Returns the extension by type and name. Does not cache the result. Does not cache the result. (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected method	GetExtensions	Gets the extensions for the given type. Does not cache the result. (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Public method	GetField	Returns a field of given name (return null if specified field does not exist).
Public method Static member	GetFieldForObject	Returns macro field object of given name if registered for specified object. It loops through all MacroFieldContainer extensions of given object type. Returns null if there is no such Extension for given object.
Public method Static member	GetFieldsForObject	Returns list of macro field extension registered for specified object. Returns null if there is no such extension for given object.
Protected method	RegisterExtension	Registers a Extension to the container. (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected method	RegisterExtensions	Registers all the fields. (Overrides MacroExtensionContainer<TContainer, TExtension>.RegisterExtensions().)
Public method	RegisterField	Registers the given field.
Protected method	RegisterFields	Registers all the fields.

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
Protected property	Extensions	Extensions dictionary (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected property	RegisteredExtensionNames	Returns enumerable of all registered Extension names. (Inherited from MacroExtensionContainer<TContainer, TExtension>.)
Protected property	RegisteredExtensions	Returns enumerable of all Extensions. (Inherited from MacroExtensionContainer<TContainer, TExtension>.)