Module Class

Represents the standard module.

Inheritance Hierarchy

System.Object
  CMS.Core.ModuleEntry
    CMS.DataEngine.Module
      More...

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

Syntax

public abstract class Module : ModuleEntry

The Module type exposes the following members.

Constructors

	Name	Description
Protected method	Module(String)	Constructor
Protected method	Module(ModuleMetadata)	Constructor

Methods

	Name	Description
Public method	ClearHashtables	Clears the module hash tables.
Public method	GetObject	Gets the object created from the given DataRow.
Public method	CheckLicense	Checks the license.
Public method	Init	Initializes the module. (Inherited from ModuleEntry.)
Protected method	OnInit	Handles the module initialization. (Inherited from ModuleEntry.)
Protected method	OnPreInit	Handles the module pre-initialization. (Inherited from ModuleEntry.)
Public method	PreInit	Pre-initializes the module. (Inherited from ModuleEntry.)
Public method	ProcessCommand	Processes the specified command.
Protected method	RegisterCommand	Registers the given command
Protected method	RegisterCommands	Registers the object type of this module
Protected method Static member	RegisterContext<ContextType>	Registers the module 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	AutoInitialize	If true, the module is allowed to be initialized automatically (Inherited from ModuleEntry.)
Public property	Initialized	True if the module was initialized (Inherited from ModuleEntry.)
Public property	IsDiscoverable	If true, this module is automatically discoverable (Inherited from ModuleEntry.)
Public property	ModuleInfo	Gets the module info. (Inherited from ModuleEntry.)
Public property	ModuleMetadata	Gets the module metadata. (Inherited from ModuleEntry.)
Public property	PreInitialized	True if the module was pre-initialized (Inherited from ModuleEntry.)
Public property	ReferencedAssembliesNames	Gets a set of names of assemblies referenced by the assembly of this module entry. (Inherited from ModuleEntry.)