MacroExtensionContainer<TContainer, TExtension> Class

Wrapper class to provide extensions to an arbitrary object. It is a base class for ExtensionTypeContainer and MacroFieldContainer classes.

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroExtensionContainer<TContainer, TExtension>
    CMS.MacroEngine.MacroExtensionContainer<TExtension>
    CMS.MacroEngine.MacroFieldContainer
    CMS.MacroEngine.MacroMethodContainer

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

Syntax

public class MacroExtensionContainer<TContainer, TExtension>
where TContainer : new(), MacroExtensionContainer<TContainer, TExtension>
where TExtension : MacroExtension

Type Parameters

TContainer

TExtension

The MacroExtensionContainer<TContainer, TExtension> type exposes the following members.

Constructors

	Name	Description
Public method	MacroExtensionContainer<TContainer, TExtension>

Methods

	Name	Description
Protected method	GetExtension(String)	Returns a Extension of given name (return null if specified Extension does not exist).
Protected method	GetExtension(Type, String)	Returns the extension by type and name. Does not cache the result. Does not cache the result.
Protected method Static member	GetExtensionForObject	Returns macro extension object of given name if registered for specified object. Caches the result in the internal cache. It loops through all extensions of given object type. Returns null if there is no such extension for given object.
Protected method	GetExtensions	Gets the extensions for the given type. Does not cache the result.
Protected method Static member	GetExtensionsForObject	Returns list of macro extension registered for specified object. Caches the result in the internal cache. Returns null if there is no such extension for given object.
Protected method Static member	CheckGlobalAdmin	Checks if the current context user is global admin, returns true if so, otherwise returns false
Protected method	RegisterExtension	Registers a Extension to the container.
Protected method	RegisterExtensions	Registers extensions to the container. Override this to call RegisterExtension from within.

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
Protected property Static member	Instance	Container instance
Protected property	RegisteredExtensionNames	Returns enumerable of all registered Extension names.
Protected property	RegisteredExtensions	Returns enumerable of all Extensions.