Class ModuleControlController
ModuleControlController provides the Business Layer for Module Controls.
Inheritance
Namespace: DotNetNuke.Entities.Modules
Assembly: DotNetNuke.dll
Syntax
public class ModuleControlController : object
Methods
| Improve this Doc View SourceAddModuleControl(ModuleControlInfo)
AddModuleControl adds a new Module Control to the database.
Declaration
public static void AddModuleControl(ModuleControlInfo objModuleControl)
Parameters
Type | Name | Description |
---|---|---|
ModuleControlInfo | objModuleControl | The Module Control to save. |
DeleteModuleControl(Int32)
DeleteModuleControl deletes a Module Control in the database.
Declaration
public static void DeleteModuleControl(int moduleControlID)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | moduleControlID | The ID of the Module Control to delete. |
GetModuleControl(Int32)
GetModuleControl gets a single Module Control from the database.
Declaration
public static ModuleControlInfo GetModuleControl(int moduleControlID)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | moduleControlID | The ID of the Module Control to fetch. |
Returns
Type | Description |
---|---|
ModuleControlInfo | The ModuleControlInfo or null. |
GetModuleControlByControlKey(String, Int32)
GetModuleControlByControlKey gets a single Module Control from the database.
Declaration
public static ModuleControlInfo GetModuleControlByControlKey(string controlKey, int moduleDefID)
Parameters
Type | Name | Description |
---|---|---|
System.String | controlKey | The key for the control. |
System.Int32 | moduleDefID | The ID of the Module Definition. |
Returns
Type | Description |
---|---|
ModuleControlInfo | The ModuleControlInfo or null. |
GetModuleControlsByModuleDefinitionID(Int32)
GetModuleControl gets a Dictionary of Module Controls by Module Definition.
Declaration
public static Dictionary<string, ModuleControlInfo> GetModuleControlsByModuleDefinitionID(int moduleDefID)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | moduleDefID | The ID of the Module Definition. |
Returns
Type | Description |
---|---|
Dictionary<System.String, ModuleControlInfo> | A |
SaveModuleControl(ModuleControlInfo, Boolean)
SaveModuleControl updates a Module Control in the database.
Declaration
public static int SaveModuleControl(ModuleControlInfo moduleControl, bool clearCache)
Parameters
Type | Name | Description |
---|---|---|
ModuleControlInfo | moduleControl | The Module Control to save. |
System.Boolean | clearCache | A flag that determines whether to clear the host cache. |
Returns
Type | Description |
---|---|
System.Int32 | The module control ID. |
UpdateModuleControl(ModuleControlInfo)
UpdateModuleControl updates a Module Control in the database.
Declaration
public static void UpdateModuleControl(ModuleControlInfo objModuleControl)
Parameters
Type | Name | Description |
---|---|---|
ModuleControlInfo | objModuleControl | The Module Control to save. |