Class ModuleDefinitionController

ModuleDefinitionController provides the Business Layer for Module Definitions.

Inheritance

System.Object

ModuleDefinitionController

Namespace: DotNetNuke.Entities.Modules.Definitions

Assembly: DotNetNuke.dll

Syntax

public class ModuleDefinitionController : object

Methods

| Improve this Doc View Source

DeleteModuleDefinition(ModuleDefinitionInfo)

GetModuleDefinitionByID gets a Module Definition by its ID.

Declaration

public void DeleteModuleDefinition(ModuleDefinitionInfo objModuleDefinition)

Parameters

Type	Name	Description
ModuleDefinitionInfo	objModuleDefinition	The object of the Module Definition.

| Improve this Doc View Source

DeleteModuleDefinition(Int32)

DeleteModuleDefinition deletes a Module Definition By ID.

Declaration

public void DeleteModuleDefinition(int moduleDefinitionId)

Parameters

Type	Name	Description
System.Int32	moduleDefinitionId	The ID of the Module Definition to delete.

| Improve this Doc View Source

GetModuleDefinitionByDefinitionName(String, Int32)

Get ModuleDefinition by DefinitionName.

Declaration

public static ModuleDefinitionInfo GetModuleDefinitionByDefinitionName(string definitionName, int desktopModuleID)

Parameters

Type	Name	Description
System.String	definitionName	The definition name.
System.Int32	desktopModuleID	The ID of the Desktop Module.

Returns

Type	Description
ModuleDefinitionInfo	A ModuleDefinition or null if not found.

| Improve this Doc View Source

GetModuleDefinitionByFriendlyName(String, Int32)

GetModuleDefinitionByFriendlyName gets a Module Definition by its Friendly Name (and DesktopModuleID).

Declaration

public static ModuleDefinitionInfo GetModuleDefinitionByFriendlyName(string friendlyName, int desktopModuleID)

Parameters

Type	Name	Description
System.String	friendlyName	The friendly name.
System.Int32	desktopModuleID	The ID of the Desktop Module.

Returns

Type	Description
ModuleDefinitionInfo	The ModuleDefinitionInfo or null.

| Improve this Doc View Source

GetModuleDefinitionByFriendlyName(String)

GetModuleDefinitionByFriendlyName gets a Module Definition by its Friendly Name (and DesktopModuleID).

Declaration

public static ModuleDefinitionInfo GetModuleDefinitionByFriendlyName(string friendlyName)

Parameters

Type	Name	Description
System.String	friendlyName	The friendly name.

Returns

Type	Description
ModuleDefinitionInfo	The ModuleDefinitionInfo or null.

| Improve this Doc View Source

GetModuleDefinitionByID(Int32)

GetModuleDefinitionByID gets a Module Definition by its ID.

Declaration

public static ModuleDefinitionInfo GetModuleDefinitionByID(int moduleDefID)

Parameters

Type	Name	Description
System.Int32	moduleDefID	The ID of the Module Definition.

Returns

Type	Description
ModuleDefinitionInfo	The ModuleDefinitionInfo or null.

| Improve this Doc View Source

GetModuleDefinitions()

GetModuleDefinitions gets a Dictionary of Module Definitions.

Declaration

public static Dictionary<int, ModuleDefinitionInfo> GetModuleDefinitions()

Returns

Type	Description
Dictionary<System.Int32, ModuleDefinitionInfo>	A mapping module definition ID to ModuleDefinitionInfo.

| Improve this Doc View Source

GetModuleDefinitionsByDesktopModuleID(Int32)

GetModuleDefinitionsByDesktopModuleID gets a Dictionary of Module Definitions with a particular DesktopModuleID, keyed by the FriendlyName.

Declaration

public static Dictionary<string, ModuleDefinitionInfo> GetModuleDefinitionsByDesktopModuleID(int desktopModuleID)

Parameters

Type	Name	Description
System.Int32	desktopModuleID	The ID of the Desktop Module.

Returns

Type	Description
Dictionary<System.String, ModuleDefinitionInfo>	A mapping module definition friendly name to ModuleDefinitionInfo.

| Improve this Doc View Source

SaveModuleDefinition(ModuleDefinitionInfo, Boolean, Boolean)

SaveModuleDefinition saves the Module Definition to the database.

Declaration

public static int SaveModuleDefinition(ModuleDefinitionInfo moduleDefinition, bool saveChildren, bool clearCache)

Parameters

Type	Name	Description
ModuleDefinitionInfo	moduleDefinition	The Module Definition to save.
System.Boolean	saveChildren	A flag that determines whether the child objects are also saved.
System.Boolean	clearCache	A flag that determines whether to clear the host cache.

Returns

Type	Description
System.Int32	The module definition ID.

Extension Methods

JsonExtensionsWeb.ToJson(Object)