Class ModuleInstanceContext

Provides context data for a particular instance of a module.

Inheritance
System.Object
ModuleInstanceContext
Namespace: DotNetNuke.UI.Modules
Assembly: DotNetNuke.dll
Syntax
public class ModuleInstanceContext : object

Constructors

| Improve this Doc View Source

ModuleInstanceContext()

Initializes a new instance of the ModuleInstanceContext class.

Declaration
public ModuleInstanceContext()
| Improve this Doc View Source

ModuleInstanceContext(IModuleControl)

Initializes a new instance of the ModuleInstanceContext class.

Declaration
public ModuleInstanceContext(IModuleControl moduleControl)
Parameters
Type Name Description
IModuleControl moduleControl

Properties

| Improve this Doc View Source

Actions

Gets or sets the Actions for this module context.

Declaration
public ModuleActionCollection Actions { get; set; }
Property Value
Type Description
ModuleActionCollection
| Improve this Doc View Source

Configuration

Gets or sets the Module Configuration (ModuleInfo) for this context.

Declaration
public ModuleInfo Configuration { get; set; }
Property Value
Type Description
ModuleInfo
| Improve this Doc View Source

EditMode

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

Declaration
public bool EditMode { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

HelpURL

Gets or sets the HelpUrl for this context.

Declaration
public string HelpURL { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IsEditable

Gets a value indicating whether the module is Editable (in Admin mode).

Declaration
public bool IsEditable { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsHostMenu

Provides context data for a particular instance of a module.

Declaration
public bool IsHostMenu { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ModuleId

Gets or sets the module ID for this context.

Declaration
public int ModuleId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

PortalAlias

Provides context data for a particular instance of a module.

Declaration
public PortalAliasInfo PortalAlias { get; }
Property Value
Type Description
PortalAliasInfo
| Improve this Doc View Source

PortalId

Provides context data for a particular instance of a module.

Declaration
public int PortalId { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

PortalSettings

Provides context data for a particular instance of a module.

Declaration
public PortalSettings PortalSettings { get; }
Property Value
Type Description
PortalSettings
| Improve this Doc View Source

Settings

Gets the settings for this context.

Declaration
public Hashtable Settings { get; }
Property Value
Type Description
Hashtable
| Improve this Doc View Source

TabId

Gets the tab ID for this context.

Declaration
public int TabId { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TabModuleId

Gets or sets the tabnmodule ID for this context.

Declaration
public int TabModuleId { get; set; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

EditUrl()

Provides context data for a particular instance of a module.

Declaration
public string EditUrl()
Returns
Type Description
System.String
| Improve this Doc View Source

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

Provides context data for a particular instance of a module.

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
| Improve this Doc View Source

EditUrl(String, String, String)

Provides context data for a particular instance of a module.

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
| Improve this Doc View Source

EditUrl(String, String)

Provides context data for a particular instance of a module.

Declaration
public string EditUrl(string keyName, string keyValue)
Parameters
Type Name Description
System.String keyName
System.String keyValue
Returns
Type Description
System.String
| Improve this Doc View Source

EditUrl(String)

Provides context data for a particular instance of a module.

Declaration
public string EditUrl(string controlKey)
Parameters
Type Name Description
System.String controlKey
Returns
Type Description
System.String
| Improve this Doc View Source

GetNextActionID()

Provides context data for a particular instance of a module.

Declaration
public int GetNextActionID()
Returns
Type Description
System.Int32
| Improve this Doc View Source

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

Provides context data for a particular instance of a module.

Declaration
public string NavigateUrl(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
| Improve this Doc View Source

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

Provides context data for a particular instance of a module.

Declaration
public string NavigateUrl(int tabID, string controlKey, string pageName, bool pageRedirect, params string[] additionalParameters)
Parameters
Type Name Description
System.Int32 tabID
System.String controlKey
System.String pageName
System.Boolean pageRedirect
System.String[] additionalParameters
Returns
Type Description
System.String

Extension Methods