Class Module

Namespace

Dynamicweb.Modules

Assembly

Dynamicweb.dll

Represents a module registration in Dynamicweb database

public class Module : IPermissionLookup, IPermissionControlled

Inheritance

object

Module

Implements

IPermissionLookup

IPermissionControlled

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Module()

Initializes a new instance of the Module class.

public Module()

Module(string)

Initializes a new instance of the Module class.

public Module(string moduleSystemName)

Parameters

moduleSystemName string

System name of the module.

Properties

Access

Gets or sets a value indicating whether this Module is access.

public bool Access { get; set; }

Property Value

bool

true if access; otherwise, false.

ControlPanel

Gets or sets the control panel script.

[Obsolete("Do not use")]
public string ControlPanel { get; set; }

Property Value

string

The control panel aspx script. I.e. /CustomModules/MyModule/MyModule_cpl.aspx

Description

Gets or sets the description.

public string Description { get; set; }

Property Value

string

The description.

EcomNotInstalledAccess

public bool EcomNotInstalledAccess { get; set; }

Property Value

bool

HiddenMode

public bool HiddenMode { get; set; }

Property Value

bool

IconClass

Gets or sets the module icon.

public KnownIcon IconClass { get; set; }

Property Value

KnownIcon

A value of the KnownIcon

ID

Gets or sets the ID.

public int ID { get; set; }

Property Value

int

The ID.

IsBeta

Gets or sets a value indicating whether this instance is beta.

public bool IsBeta { get; set; }

Property Value

bool

true if this instance is beta; otherwise, false.

Name

Gets or sets the name.

public string Name { get; set; }

Property Value

string

The name.

Paragraph

Gets or sets a value indicating whether this Module is paragraph.

public bool Paragraph { get; set; }

Property Value

bool

true if paragraph; otherwise, false.

ParagraphEditPath

Gets or sets the paragraph edit path.

[Obsolete("Do not use")]
public string ParagraphEditPath { get; set; }

Property Value

string

The paragraph edit path.

PermissionSettings

Gets or sets the search settings.

public ModulePermissionSettings PermissionSettings { get; set; }

Property Value

ModulePermissionSettings

The search settings.

Script

Gets or sets the script.

[Obsolete("Do not use")]
public string Script { get; set; }

Property Value

string

The script.

SearchSettings

Gets or sets the search settings.

public ModuleSearchSettings SearchSettings { get; set; }

Property Value

ModuleSearchSettings

The search settings.

Sort

Gets or sets the sort.

public int Sort { get; set; }

Property Value

int

The sort.

SystemName

Gets or sets the name of the system.

public string SystemName { get; set; }

Property Value

string

The name of the system.

Methods

GetByKey(string)

Can be used to look up a concrete object based upon the key.

public IPermissionControlled GetByKey(string key)

Parameters

key string

Identifier

Returns

IPermissionControlled

permissionControlled

GetParent()

Gets the parent of this object, for the purposes of inherited permissions.

public IPermissionControlled GetParent()

Returns

IPermissionControlled

parent

Remarks

Return null, if no parent permissions exist

GetPermissionIdentifier()

Combination of values that form a unique identifier.

public UnifiedPermissionIdentifier GetPermissionIdentifier()

Returns

UnifiedPermissionIdentifier

Unique identifier.