Class PortalModuleBase

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Inheritance

System.Object

UserControlBase

PortalModuleBase

ModuleSettingsBase

UserModuleBase

AuthenticationSettingsBase

FolderMappingSettingsControlBase

Help

Implements

IModuleControl

Inherited Members

UserControlBase.IsHostMenu

UserControlBase.PortalSettings

Namespace: DotNetNuke.Entities.Modules

Assembly: DotNetNuke.dll

Syntax

public class PortalModuleBase : UserControlBase, IModuleControl

Fields

FileInfoRegex

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

protected static readonly Regex FileInfoRegex

Field Value

Type	Description
Regex

Properties

Actions

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public ModuleActionCollection Actions { get; set; }

Property Value

Type	Description
ModuleActionCollection

CacheDirectory

Gets the CacheDirectory property is used to return the location of the "Cache" Directory for the Module.

Declaration

public string CacheDirectory { get; }

Property Value

Type	Description
System.String

CacheFileName

Gets the CacheFileName property is used to store the FileName for this Module's Cache.

Declaration

public string CacheFileName { get; }

Property Value

Type	Description
System.String

CacheKey

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public string CacheKey { get; }

Property Value

Type	Description
System.String

ContainerControl

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public Control ContainerControl { get; }

Property Value

Type	Description
Control

Control

Gets the underlying base control for this ModuleControl.

Declaration

public Control Control { get; }

Property Value

Type	Description
Control	A String.

ControlName

Gets the Name for this control.

Declaration

public string ControlName { get; }

Property Value

Type	Description
System.String	A String.

ControlPath

Gets the Path for this control (used primarily for UserControls).

Declaration

public string ControlPath { get; }

Property Value

Type	Description
System.String	A String.

DependencyProvider

Gets the Dependency Provider to resolve registered services with the container.

Declaration

protected IServiceProvider DependencyProvider { get; }

Property Value

Type	Description
IServiceProvider	The Dependency Service.

EditMode

Gets a value indicating whether the EditMode property is used to determine whether the user is in the Administrator role Cache.

Declaration

public bool EditMode { get; }

Property Value

Type	Description
System.Boolean

HelpURL

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public string HelpURL { get; set; }

Property Value

Type	Description
System.String

IsEditable

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public bool IsEditable { get; }

Property Value

Type	Description
System.Boolean

LocalResourceFile

Gets or sets the local resource file for this control.

Declaration

public string LocalResourceFile { get; set; }

Property Value

Type	Description
System.String	A String.

ModuleConfiguration

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public ModuleInfo ModuleConfiguration { get; set; }

Property Value

Type	Description
ModuleInfo

ModuleContext

Gets the Module Context for this control.

Declaration

public ModuleInstanceContext ModuleContext { get; }

Property Value

Type	Description
ModuleInstanceContext	A ModuleInstanceContext.

ModuleId

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public int ModuleId { get; set; }

Property Value

Type	Description
System.Int32

PortalAlias

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public PortalAliasInfo PortalAlias { get; }

Property Value

Type	Description
PortalAliasInfo

PortalId

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public int PortalId { get; }

Property Value

Type	Description
System.Int32

Settings

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public Hashtable Settings { get; }

Property Value

Type	Description
Hashtable

TabId

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public int TabId { get; }

Property Value

Type	Description
System.Int32

TabModuleId

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public int TabModuleId { get; set; }

Property Value

Type	Description
System.Int32

UserId

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public int UserId { get; }

Property Value

Type	Description
System.Int32

UserInfo

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public UserInfo UserInfo { get; }

Property Value

Type	Description
UserInfo

Methods

AddActionHandler(ActionEventHandler)

Helper method that can be used to add an ActionEventHandler to the Skin for this Module Control.

Declaration

protected void AddActionHandler(ActionEventHandler e)

Parameters

Type	Name	Description
ActionEventHandler	e

Dispose()

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public override void Dispose()

EditUrl()

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public string EditUrl()

Returns

Type	Description
System.String

EditUrl(Int32, String, Boolean, String[])

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public string EditUrl(int tabID, string controlKey, bool pageRedirect, params string[] additionalParameters)

Parameters

Type	Name	Description
System.Int32	tabID
System.String	controlKey
System.Boolean	pageRedirect
System.String[]	additionalParameters

Returns

Type	Description
System.String

EditUrl(String, String, String, String[])

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public string EditUrl(string keyName, string keyValue, string controlKey, params string[] additionalParameters)

Parameters

Type	Name	Description
System.String	keyName
System.String	keyValue
System.String	controlKey
System.String[]	additionalParameters

Returns

Type	Description
System.String

EditUrl(String, String, String)

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public string EditUrl(string keyName, string keyValue, string controlKey)

Parameters

Type	Name	Description
System.String	keyName
System.String	keyValue
System.String	controlKey

Returns

Type	Description
System.String

EditUrl(String, String)

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public string EditUrl(string keyName, string keyValue)

Parameters

Type	Name	Description
System.String	keyName
System.String	keyValue

Returns

Type	Description
System.String

EditUrl(String)

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public string EditUrl(string controlKey)

Parameters

Type	Name	Description
System.String	controlKey

Returns

Type	Description
System.String

GetCacheFileName(Int32)

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public string GetCacheFileName(int tabModuleId)

Parameters

Type	Name	Description
System.Int32	tabModuleId

Returns

Type	Description
System.String

GetCacheKey(Int32)

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public string GetCacheKey(int tabModuleId)

Parameters

Type	Name	Description
System.Int32	tabModuleId

Returns

Type	Description
System.String

GetNextActionID()

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public int GetNextActionID()

Returns

Type	Description
System.Int32

LocalizeSafeJsString(String)

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

protected string LocalizeSafeJsString(string key)

Parameters

Type	Name	Description
System.String	key

Returns

Type	Description
System.String

LocalizeString(String)

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

protected string LocalizeString(string key)

Parameters

Type	Name	Description
System.String	key

Returns

Type	Description
System.String

OnInit(EventArgs)

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

protected override void OnInit(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

OnLoad(EventArgs)

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

protected override void OnLoad(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

SynchronizeModule()

The PortalModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal.

The PortalModuleBase class defines portal specific properties that are used by the portal framework to correctly display portal modules.

Declaration

public void SynchronizeModule()

Implements

IModuleControl

Extension Methods

JsonExtensionsWeb.ToJson(Object)