Class AdminModule

Namespace

Kentico.Xperience.Admin.Base

Assembly

Kentico.Xperience.Admin.Base.dll

Represents a Kentico Xperience module, with options to register client SystemJs modules.

public abstract class AdminModule : Module

Inheritance

object

ModuleEntry

Module

AdminModule

Inherited Members

Module.ClearHashtables(bool)

Module.RegisterReservedNamespace(string)

Module.GetObject(string)

Module.RegisterContext<ContextType>(string)

ModuleEntry.Name

ModuleEntry.Initialized

ModuleEntry.PreInitialized

ModuleEntry.PreInit()

ModuleEntry.PreInit(ModulePreInitParameters)

ModuleEntry.Init()

ModuleEntry.Init(ModuleInitParameters)

ModuleEntry.OnPreInit()

ModuleEntry.OnPreInit(ModulePreInitParameters)

ModuleEntry.OnInit(ModuleInitParameters)

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

AdminModule(string)

Creates a new instance of the AdminModule class.

protected AdminModule(string moduleName)

Parameters

moduleName string

Module name

Methods

OnInit()

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

protected override 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.

RegisterClientModule(string, string, IEnumerable<ClientModuleDescriptor>)

Registers a client SystemJs module.

protected void RegisterClientModule(string organizationName, string projectName, IEnumerable<ClientModuleDescriptor> dependencies = null)

Parameters

organizationName string

Organization name used as an unique namespace prefix.

projectName string

Project name

dependencies IEnumerable<ClientModuleDescriptor>

List of SystemJs modules this module depends on.

RegisterDefaultValueComponent(string, string, Func<object, string>, Func<string, object>)

Registers component for editing default value in field editor for the given data type. DataType.

protected void RegisterDefaultValueComponent(string dataType, string componentIdentifier, Func<object, string> serializationFunction, Func<string, object> deserializationFunction)

Parameters

dataType string

The data type.

componentIdentifier string

The form component identifier.

serializationFunction Func<object, string>

Function that handles serialization of the form component's underlying type to it's string representation.

deserializationFunction Func<string, object>

Function that handles deserialization from string into the form component's underlying type.

Exceptions

InvalidOperationException

Missing registration for serialization/deserialization function.