Class PortalModuleBase

Inheritance
object
Control
TemplateControl
UserControl
UserControlBase
PortalModuleBase
ModuleSettingsBase
UserModuleBase
AuthenticationSettingsBase
FolderMappingSettingsControlBase
Help
Implements
Inherited Members
Namespace: DotNetNuke.Entities.Modules
Assembly: DotNetNuke.dll
Syntax
public class PortalModuleBase : UserControlBase, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IFilterResolutionService, IAttributeAccessor, INamingContainer, IUserControlDesignerAccessor, IModuleControl

Constructors

PortalModuleBase()

Declaration
public PortalModuleBase()

Fields

FileInfoRegex

Declaration
protected static readonly Regex FileInfoRegex
Field Value
Type Description
Regex

Properties

Actions

Declaration
[Browsable(false)]
public ModuleActionCollection Actions { get; set; }
Property Value
Type Description
ModuleActionCollection

CacheDirectory

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. Please use ModuleController.CacheDirectory(). Scheduled removal in v11.0.0.")]
public string CacheDirectory { get; }
Property Value
Type Description
string

CacheFileName

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. Please use ModuleController.CacheFileName(TabModuleID). Scheduled removal in v11.0.0.")]
public string CacheFileName { get; }
Property Value
Type Description
string

CacheKey

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. Please use ModuleController.CacheKey(TabModuleID). Scheduled removal in v11.0.0.")]
public string CacheKey { get; }
Property Value
Type Description
string

ContainerControl

Declaration
[Browsable(false)]
public Control ContainerControl { get; }
Property Value
Type Description
Control

Control

Declaration
public Control Control { get; }
Property Value
Type Description
Control

ControlName

Declaration
public string ControlName { get; }
Property Value
Type Description
string

ControlPath

Declaration
public string ControlPath { get; }
Property Value
Type Description
string

DependencyProvider

Declaration
protected IServiceProvider DependencyProvider { get; }
Property Value
Type Description
IServiceProvider

EditMode

Declaration
public bool EditMode { get; }
Property Value
Type Description
bool

HelpURL

Declaration
public string HelpURL { get; set; }
Property Value
Type Description
string

IsEditable

Declaration
[Browsable(false)]
public bool IsEditable { get; }
Property Value
Type Description
bool

LocalResourceFile

Declaration
public string LocalResourceFile { get; set; }
Property Value
Type Description
string

ModuleConfiguration

Declaration
[Browsable(false)]
public ModuleInfo ModuleConfiguration { get; set; }
Property Value
Type Description
ModuleInfo

ModuleContext

Declaration
public ModuleInstanceContext ModuleContext { get; }
Property Value
Type Description
ModuleInstanceContext

ModuleId

Declaration
[Browsable(false)]
public int ModuleId { get; set; }
Property Value
Type Description
int

PortalAlias

Declaration
[Browsable(false)]
public PortalAliasInfo PortalAlias { get; }
Property Value
Type Description
PortalAliasInfo

PortalId

Declaration
[Browsable(false)]
public int PortalId { get; }
Property Value
Type Description
int

Settings

Declaration
[Browsable(false)]
public Hashtable Settings { get; }
Property Value
Type Description
Hashtable

TabId

Declaration
[Browsable(false)]
public int TabId { get; }
Property Value
Type Description
int

TabModuleId

Declaration
[Browsable(false)]
public int TabModuleId { get; set; }
Property Value
Type Description
int

UserId

Declaration
[Browsable(false)]
public int UserId { get; }
Property Value
Type Description
int

UserInfo

Declaration
[Browsable(false)]
public UserInfo UserInfo { get; }
Property Value
Type Description
UserInfo

Methods

AddActionHandler(ActionEventHandler)

Declaration
protected void AddActionHandler(ActionEventHandler e)
Parameters
Type Name Description
ActionEventHandler e

Dispose()

Declaration
public override void Dispose()
Overrides

EditUrl()

Declaration
[Browsable(false)]
public string EditUrl()
Returns
Type Description
string

EditUrl(int, string, bool, params string[])

Declaration
[Browsable(false)]
public string EditUrl(int tabID, string controlKey, bool pageRedirect, params string[] additionalParameters)
Parameters
Type Name Description
int tabID
string controlKey
bool pageRedirect
string[] additionalParameters
Returns
Type Description
string

EditUrl(string)

Declaration
[Browsable(false)]
public string EditUrl(string controlKey)
Parameters
Type Name Description
string controlKey
Returns
Type Description
string

EditUrl(string, string)

Declaration
[Browsable(false)]
public string EditUrl(string keyName, string keyValue)
Parameters
Type Name Description
string keyName
string keyValue
Returns
Type Description
string

EditUrl(string, string, string)

Declaration
[Browsable(false)]
public string EditUrl(string keyName, string keyValue, string controlKey)
Parameters
Type Name Description
string keyName
string keyValue
string controlKey
Returns
Type Description
string

EditUrl(string, string, string, params string[])

Declaration
[Browsable(false)]
public string EditUrl(string keyName, string keyValue, string controlKey, params string[] additionalParameters)
Parameters
Type Name Description
string keyName
string keyValue
string controlKey
string[] additionalParameters
Returns
Type Description
string

GetCacheFileName(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. Please use ModuleController.CacheFileName(TabModuleID). Scheduled for removal in v11.0.0.")]
public string GetCacheFileName(int tabModuleId)
Parameters
Type Name Description
int tabModuleId
Returns
Type Description
string

GetCacheKey(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. Please use ModuleController.CacheKey(TabModuleID). Scheduled for removal in v11.0.0.")]
public string GetCacheKey(int tabModuleId)
Parameters
Type Name Description
int tabModuleId
Returns
Type Description
string

GetNextActionID()

Declaration
public int GetNextActionID()
Returns
Type Description
int

LocalizeSafeJsString(string)

Declaration
protected string LocalizeSafeJsString(string key)
Parameters
Type Name Description
string key
Returns
Type Description
string

LocalizeString(string)

Declaration
protected string LocalizeString(string key)
Parameters
Type Name Description
string key
Returns
Type Description
string

OnInit(EventArgs)

Declaration
protected override void OnInit(EventArgs e)
Parameters
Type Name Description
EventArgs e
Overrides

OnLoad(EventArgs)

Declaration
protected override void OnLoad(EventArgs e)
Parameters
Type Name Description
EventArgs e
Overrides

SynchronizeModule()

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. Please use ModuleController.SynchronizeModule(ModuleId). Scheduled for removal in v11.0.0.")]
public void SynchronizeModule()

Implements

Extension Methods