Class ModuleController

Inheritance

object

ServiceLocator<IModuleController, ModuleController>

ModuleController

Implements

IModuleController

Inherited Members

ServiceLocator<IModuleController, ModuleController>.SetTestableInstance(IModuleController)

ServiceLocator<IModuleController, ModuleController>.ClearInstance()

ServiceLocator<IModuleController, ModuleController>.GetFactory()

ServiceLocator<IModuleController, ModuleController>.Instance

ServiceLocator<IModuleController, ModuleController>.Factory

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.Entities.Modules

Assembly: DotNetNuke.dll

Syntax

public class ModuleController : ServiceLocator<IModuleController, ModuleController>, IModuleController

Constructors

ModuleController()

Declaration

public ModuleController()

Methods

AddModule(ModuleInfo)

Declaration

public int AddModule(ModuleInfo module)

Parameters

Type	Name	Description
ModuleInfo	module

Returns

Type	Description
int

ClearCache(int)

Declaration

public void ClearCache(int tabId)

Parameters

Type	Name	Description
int	tabId

CopyModule(ModuleInfo, TabInfo, string, bool)

Declaration

public void CopyModule(ModuleInfo sourceModule, TabInfo destinationTab, string toPaneName, bool includeSettings)

Parameters

Type	Name	Description
ModuleInfo	sourceModule
TabInfo	destinationTab
string	toPaneName
bool	includeSettings

CopyModules(TabInfo, TabInfo, bool)

Declaration

public void CopyModules(TabInfo sourceTab, TabInfo destinationTab, bool asReference)

Parameters

Type	Name	Description
TabInfo	sourceTab
TabInfo	destinationTab
bool	asReference

CopyModules(TabInfo, TabInfo, bool, bool)

Declaration

public void CopyModules(TabInfo sourceTab, TabInfo destinationTab, bool asReference, bool includeAllTabsMobules)

Parameters

Type	Name	Description
TabInfo	sourceTab
TabInfo	destinationTab
bool	asReference
bool	includeAllTabsMobules

CreateContentItem(ModuleInfo)

Declaration

public void CreateContentItem(ModuleInfo module)

Parameters

Type	Name	Description
ModuleInfo	module

DeLocalizeModule(ModuleInfo)

Declaration

public int DeLocalizeModule(ModuleInfo sourceModule)

Parameters

Type	Name	Description
ModuleInfo	sourceModule

Returns

Type	Description
int

DeleteAllModules(int, int, List<TabInfo>, bool, bool, bool)

Declaration

public void DeleteAllModules(int moduleId, int tabId, List<TabInfo> fromTabs, bool softDelete, bool includeCurrent, bool deleteBaseModule)

Parameters

Type	Name	Description
int	moduleId
int	tabId
List<TabInfo>	fromTabs
bool	softDelete
bool	includeCurrent
bool	deleteBaseModule

DeleteModule(int)

Declaration

public void DeleteModule(int moduleId)

Parameters

Type	Name	Description
int	moduleId

DeleteModuleSetting(int, string)

Declaration

public void DeleteModuleSetting(int moduleId, string settingName)

Parameters

Type	Name	Description
int	moduleId
string	settingName

DeleteTabModule(int, int, bool)

Declaration

public void DeleteTabModule(int tabId, int moduleId, bool softDelete)

Parameters

Type	Name	Description
int	tabId
int	moduleId
bool	softDelete

DeleteTabModuleSetting(int, string)

Declaration

public void DeleteTabModuleSetting(int tabModuleId, string settingName)

Parameters

Type	Name	Description
int	tabModuleId
string	settingName

DeserializeModule(IBusinessControllerProvider, XmlNode, ModuleInfo, int, int)

Declaration

public static void DeserializeModule(IBusinessControllerProvider businessControllerProvider, XmlNode nodeModule, ModuleInfo module, int portalId, int tabId)

Parameters

Type	Name	Description
IBusinessControllerProvider	businessControllerProvider
XmlNode	nodeModule
ModuleInfo	module
int	portalId
int	tabId

DeserializeModule(IBusinessControllerProvider, XmlNode, XmlNode, int, int, PortalTemplateModuleAction, Hashtable)

Declaration

public static void DeserializeModule(IBusinessControllerProvider businessControllerProvider, XmlNode nodeModule, XmlNode nodePane, int portalId, int tabId, PortalTemplateModuleAction mergeTabs, Hashtable hModules)

Parameters

Type	Name	Description
IBusinessControllerProvider	businessControllerProvider
XmlNode	nodeModule
XmlNode	nodePane
int	portalId
int	tabId
PortalTemplateModuleAction	mergeTabs
Hashtable	hModules

DeserializeModule(XmlNode, ModuleInfo, int, int)

Declaration

[Obsolete("Deprecated in DotNetNuke 10.0.0. Please use overload with IBusinessControllerProvider. Scheduled for removal in v12.0.0.")]
public static void DeserializeModule(XmlNode nodeModule, ModuleInfo module, int portalId, int tabId)

Parameters

Type	Name	Description
XmlNode	nodeModule
ModuleInfo	module
int	portalId
int	tabId

DeserializeModule(XmlNode, XmlNode, int, int, PortalTemplateModuleAction, Hashtable)

Declaration

[Obsolete("Deprecated in DotNetNuke 10.0.0. Please use overload with IBusinessControllerProvider. Scheduled for removal in v12.0.0.")]
public static void DeserializeModule(XmlNode nodeModule, XmlNode nodePane, int portalId, int tabId, PortalTemplateModuleAction mergeTabs, Hashtable hModules)

Parameters

Type	Name	Description
XmlNode	nodeModule
XmlNode	nodePane
int	portalId
int	tabId
PortalTemplateModuleAction	mergeTabs
Hashtable	hModules

GetAllModules()

Declaration

public ArrayList GetAllModules()

Returns

Type	Description
ArrayList

GetAllTabsModules(int, bool)

Declaration

public ArrayList GetAllTabsModules(int portalID, bool allTabs)

Parameters

Type	Name	Description
int	portalID
bool	allTabs

Returns

Type	Description
ArrayList

GetAllTabsModulesByModuleID(int)

Declaration

public ArrayList GetAllTabsModulesByModuleID(int moduleID)

Parameters

Type	Name	Description
int	moduleID

Returns

Type	Description
ArrayList

GetFactory()

Declaration

protected override Func<IModuleController> GetFactory()

Returns

Type	Description
Func<IModuleController>

Overrides

ServiceLocator<IModuleController, ModuleController>.GetFactory()

GetMasterTabId(ModuleInfo)

Declaration

public int GetMasterTabId(ModuleInfo module)

Parameters

Type	Name	Description
ModuleInfo	module

Returns

Type	Description
int

GetModule(int)

Declaration

public ModuleInfo GetModule(int moduleID)

Parameters

Type	Name	Description
int	moduleID

Returns

Type	Description
ModuleInfo

GetModule(int, int)

Declaration

public ModuleInfo GetModule(int moduleID, int tabID)

Parameters

Type	Name	Description
int	moduleID
int	tabID

Returns

Type	Description
ModuleInfo

GetModule(int, int, bool)

Declaration

public ModuleInfo GetModule(int moduleID, int tabID, bool ignoreCache)

Parameters

Type	Name	Description
int	moduleID
int	tabID
bool	ignoreCache

Returns

Type	Description
ModuleInfo

GetModuleByCulture(int, int, int, Locale)

Declaration

public ModuleInfo GetModuleByCulture(int moduleId, int tabid, int portalId, Locale locale)

Parameters

Type	Name	Description
int	moduleId
int	tabid
int	portalId
Locale	locale

Returns

Type	Description
ModuleInfo

GetModuleByDefinition(int, string)

Declaration

public ModuleInfo GetModuleByDefinition(int portalId, string definitionName)

Parameters

Type	Name	Description
int	portalId
string	definitionName

Returns

Type	Description
ModuleInfo

GetModuleByUniqueID(Guid)

Declaration

public ModuleInfo GetModuleByUniqueID(Guid uniqueID)

Parameters

Type	Name	Description
Guid	uniqueID

Returns

Type	Description
ModuleInfo

GetModules(int)

Declaration

public ArrayList GetModules(int portalID)

Parameters

Type	Name	Description
int	portalID

Returns

Type	Description
ArrayList

GetModulesByDefinition(int, string)

Declaration

public ArrayList GetModulesByDefinition(int portalID, string definitionName)

Parameters

Type	Name	Description
int	portalID
string	definitionName

Returns

Type	Description
ArrayList

GetModulesByDesktopModuleId(int)

Declaration

public ArrayList GetModulesByDesktopModuleId(int desktopModuleId)

Parameters

Type	Name	Description
int	desktopModuleId

Returns

Type	Description
ArrayList

GetSearchModules(int)

Declaration

public ArrayList GetSearchModules(int portalID)

Parameters

Type	Name	Description
int	portalID

Returns

Type	Description
ArrayList

GetTabModule(int)

Declaration

public ModuleInfo GetTabModule(int tabModuleID)

Parameters

Type	Name	Description
int	tabModuleID

Returns

Type	Description
ModuleInfo

GetTabModules(int)

Declaration

public Dictionary<int, ModuleInfo> GetTabModules(int tabId)

Parameters

Type	Name	Description
int	tabId

Returns

Type	Description
Dictionary<int, ModuleInfo>

GetTabModulesByModule(int)

Declaration

public IList<ModuleInfo> GetTabModulesByModule(int moduleID)

Parameters

Type	Name	Description
int	moduleID

Returns

Type	Description
IList<ModuleInfo>

InitialModulePermission(ModuleInfo, int, int)

Declaration

public void InitialModulePermission(ModuleInfo module, int tabId, int permissionType)

Parameters

Type	Name	Description
ModuleInfo	module
int	tabId
int	permissionType

IsSharedModule(ModuleInfo)

Declaration

public bool IsSharedModule(ModuleInfo module)

Parameters

Type	Name	Description
ModuleInfo	module

Returns

Type	Description
bool

LocalizeModule(ModuleInfo, Locale)

Declaration

public void LocalizeModule(ModuleInfo sourceModule, Locale locale)

Parameters

Type	Name	Description
ModuleInfo	sourceModule
Locale	locale

MoveModule(int, int, int, string)

Declaration

public void MoveModule(int moduleId, int fromTabId, int toTabId, string toPaneName)

Parameters

Type	Name	Description
int	moduleId
int	fromTabId
int	toTabId
string	toPaneName

RestoreModule(ModuleInfo)

Declaration

public void RestoreModule(ModuleInfo objModule)

Parameters

Type	Name	Description
ModuleInfo	objModule

SerializeModule(IBusinessControllerProvider, XmlDocument, ModuleInfo, bool)

Declaration

public static XmlNode SerializeModule(IBusinessControllerProvider businessControllerProvider, XmlDocument xmlModule, ModuleInfo module, bool includeContent)

Parameters

Type	Name	Description
IBusinessControllerProvider	businessControllerProvider
XmlDocument	xmlModule
ModuleInfo	module
bool	includeContent

Returns

Type	Description
XmlNode

SerializeModule(XmlDocument, ModuleInfo, bool)

Declaration

[Obsolete("Deprecated in DotNetNuke 10.0.0. Please use overload with IBusinessControllerProvider. Scheduled for removal in v12.0.0.")]
public static XmlNode SerializeModule(XmlDocument xmlModule, ModuleInfo module, bool includeContent)

Parameters

Type	Name	Description
XmlDocument	xmlModule
ModuleInfo	module
bool	includeContent

Returns

Type	Description
XmlNode

SynchronizeModule(int)

Declaration

public static void SynchronizeModule(int moduleID)

Parameters

Type	Name	Description
int	moduleID

UpdateModule(ModuleInfo)

Declaration

public void UpdateModule(ModuleInfo module)

Parameters

Type	Name	Description
ModuleInfo	module

UpdateModuleOrder(int, int, int, string)

Declaration

public void UpdateModuleOrder(int tabId, int moduleId, int moduleOrder, string paneName)

Parameters

Type	Name	Description
int	tabId
int	moduleId
int	moduleOrder
string	paneName

UpdateModuleSetting(int, string, string)

Declaration

public void UpdateModuleSetting(int moduleId, string settingName, string settingValue)

Parameters

Type	Name	Description
int	moduleId
string	settingName
string	settingValue

UpdateTabModuleOrder(int)

Declaration

public void UpdateTabModuleOrder(int tabId)

Parameters

Type	Name	Description
int	tabId

UpdateTabModuleSetting(int, string, string)

Declaration

public void UpdateTabModuleSetting(int tabModuleId, string settingName, string settingValue)

Parameters

Type	Name	Description
int	tabModuleId
string	settingName
string	settingValue

UpdateTranslationStatus(ModuleInfo, bool)

Declaration

public void UpdateTranslationStatus(ModuleInfo localizedModule, bool isTranslated)

Parameters

Type	Name	Description
ModuleInfo	localizedModule
bool	isTranslated

Implements

IModuleController

Extension Methods

JsonExtensionsWeb.ToJson(object)