Class ModuleEntry

Namespace

CMS.Core

Assembly

CMS.Core.dll

Represents the standard module entry.

public abstract class ModuleEntry

Inheritance

object

ModuleEntry

Derived

Module

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

ModuleEntry(string)

Constructor

protected ModuleEntry(string name)

Parameters

name string

Properties

Initialized

True if the module was initialized

public bool Initialized { get; protected set; }

Property Value

bool

Name

Gets the module name.

public string Name { get; protected set; }

Property Value

string

PreInitialized

True if the module was pre-initialized

public bool PreInitialized { get; protected set; }

Property Value

bool

Methods

Init()

Initializes the module.

[Obsolete("Use Init(ModuleInitParameters) instead.")]
[ObsoleteSince(28, 0)]
public void Init()

Init(ModuleInitParameters)

Initializes the module.

public void Init(ModuleInitParameters parameters)

Parameters

parameters ModuleInitParameters

Module initialization parameters.

Exceptions

ArgumentNullException

Thrown when parameters is null.

InvalidOperationException

Thrown when the module has not been pre-initialized before calling this method.

OnInit()

Override this method to perform actions required to initialize the module.

protected virtual void OnInit()

Remarks

The initialization is invoked after the service container has been built.

Use the OnInit(ModuleInitParameters) method override for access to application services needed for module initialization.

OnInit(ModuleInitParameters)

Override this method to perform actions required to initialize the module.

protected virtual void OnInit(ModuleInitParameters parameters)

Parameters

parameters ModuleInitParameters

Module initialization parameters.

Remarks

The initialization is invoked after the service container has been built. Use the parameters object to resolve application services needed for module initialization.

OnPreInit()

Override this method to perform actions required to pre-initialize the module.

protected virtual void OnPreInit()

Remarks

The pre-initialization is invoked before the service container is built.

Use the OnPreInit(ModulePreInitParameters) method override for access to service collection.

OnPreInit(ModulePreInitParameters)

Override this method to perform actions required to pre-initialize the module.

protected virtual void OnPreInit(ModulePreInitParameters parameters)

Parameters

parameters ModulePreInitParameters

Module pre-initialization parameters.

Remarks

The pre-initialization is invoked before the service container is built. Use the parameters object to configure the service collection.

PreInit()

Pre-initializes the module.

[Obsolete("Use PreInit(ModulePreInitParameters) instead.")]
[ObsoleteSince(28, 0)]
public void PreInit()

PreInit(ModulePreInitParameters)

Pre-initializes the module.

public void PreInit(ModulePreInitParameters parameters)

Parameters

parameters ModulePreInitParameters

Module pre-initialization parameters.

Exceptions

ArgumentNullException

Thrown when parameters is null.