Class ModuleInfo

ModuleInfo provides the Entity Layer for Modules.

Inheritance

System.Object

BaseEntityInfo

ContentItem

ModuleInfo

Implements

IHydratable

IPropertyAccess

Inherited Members

ContentItem.Metadata

ContentItem.Terms

ContentItem.Files

ContentItem.Videos

ContentItem.Images

ContentItem.ContentItemId

ContentItem.Content

ContentItem.ContentKey

ContentItem.ContentTypeId

ContentItem.Indexed

ContentItem.ModuleID

ContentItem.TabID

ContentItem.ContentTitle

ContentItem.StateID

ContentItem.FillInternal(IDataReader)

ContentItem.Clone(ContentItem, ContentItem)

BaseEntityInfo.CreatedByUserID

BaseEntityInfo.CreatedOnDate

BaseEntityInfo.LastModifiedByUserID

BaseEntityInfo.LastModifiedOnDate

BaseEntityInfo.CreatedByUser(Int32)

BaseEntityInfo.LastModifiedByUser(Int32)

BaseEntityInfo.CloneBaseProperties(BaseEntityInfo, BaseEntityInfo)

Namespace: DotNetNuke.Entities.Modules

Assembly: DotNetNuke.dll

Syntax

public class ModuleInfo : ContentItem, IHydratable, IPropertyAccess

Constructors

| Improve this Doc View Source

ModuleInfo()

Initializes a new instance of the ModuleInfo class.

Declaration

public ModuleInfo()

Properties

| Improve this Doc View Source

Alignment

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string Alignment { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

AllModules

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool AllModules { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

AllTabs

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool AllTabs { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Border

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string Border { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Cacheability

Gets the cache level for property access.

Declaration

public CacheLevel Cacheability { get; }

Property Value

Type	Description
CacheLevel

| Improve this Doc View Source

CacheMethod

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string CacheMethod { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

CacheTime

ModuleInfo provides the Entity Layer for Modules.

Declaration

public int CacheTime { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Color

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string Color { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ContainerPath

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string ContainerPath { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ContainerSrc

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string ContainerSrc { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

CultureCode

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string CultureCode { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

DefaultLanguageGuid

ModuleInfo provides the Entity Layer for Modules.

Declaration

public Guid DefaultLanguageGuid { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

DefaultLanguageModule

ModuleInfo provides the Entity Layer for Modules.

Declaration

public ModuleInfo DefaultLanguageModule { get; }

Property Value

Type	Description
ModuleInfo

| Improve this Doc View Source

DesktopModule

Gets the Associated Desktop Module.

Declaration

public DesktopModuleInfo DesktopModule { get; }

Property Value

Type	Description
DesktopModuleInfo	An Integer.

| Improve this Doc View Source

DesktopModuleID

Gets or sets the ID of the Associated Desktop Module.

Declaration

public int DesktopModuleID { get; set; }

Property Value

Type	Description
System.Int32	An Integer.

| Improve this Doc View Source

DisplayPrint

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool DisplayPrint { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

DisplaySyndicate

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool DisplaySyndicate { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

DisplayTitle

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool DisplayTitle { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

EndDate

ModuleInfo provides the Entity Layer for Modules.

Declaration

public DateTime EndDate { get; set; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

Footer

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string Footer { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Header

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string Header { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

HideAdminBorder

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool HideAdminBorder { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IconFile

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string IconFile { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

InheritViewPermissions

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool InheritViewPermissions { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsDefaultLanguage

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool IsDefaultLanguage { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsDefaultModule

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool IsDefaultModule { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsDeleted

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool IsDeleted { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsLocalized

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool IsLocalized { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsNeutralCulture

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool IsNeutralCulture { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsShareable

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool IsShareable { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsShareableViewOnly

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool IsShareableViewOnly { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsShared

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool IsShared { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsTranslated

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool IsTranslated { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsWebSlice

ModuleInfo provides the Entity Layer for Modules.

Declaration

public bool IsWebSlice { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

KeyID

Gets or sets the Key ID.

Declaration

public override int KeyID { get; set; }

Property Value

Type	Description
System.Int32	An Integer.

Overrides

ContentItem.KeyID

| Improve this Doc View Source

LastContentModifiedOnDate

ModuleInfo provides the Entity Layer for Modules.

Declaration

public DateTime LastContentModifiedOnDate { get; set; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

LocalizedModules

ModuleInfo provides the Entity Layer for Modules.

Declaration

public Dictionary<string, ModuleInfo> LocalizedModules { get; }

Property Value

Type	Description
Dictionary<System.String, ModuleInfo>

| Improve this Doc View Source

LocalizedVersionGuid

ModuleInfo provides the Entity Layer for Modules.

Declaration

public Guid LocalizedVersionGuid { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

ModuleControl

ModuleInfo provides the Entity Layer for Modules.

Declaration

public ModuleControlInfo ModuleControl { get; }

Property Value

Type	Description
ModuleControlInfo

| Improve this Doc View Source

ModuleControlId

ModuleInfo provides the Entity Layer for Modules.

Declaration

public int ModuleControlId { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

ModuleDefID

Gets or sets the ID of the Associated Module Definition.

Declaration

public int ModuleDefID { get; set; }

Property Value

Type	Description
System.Int32	An Integer.

| Improve this Doc View Source

ModuleDefinition

Gets the Associated Module Definition.

Declaration

public ModuleDefinitionInfo ModuleDefinition { get; }

Property Value

Type	Description
ModuleDefinitionInfo	A ModuleDefinitionInfo.

| Improve this Doc View Source

ModuleOrder

ModuleInfo provides the Entity Layer for Modules.

Declaration

public int ModuleOrder { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

ModulePermissions

Gets or sets get the ModulePermissions for the Module DO NOT USE THE SETTTER. Since 5.0 the setter has been obsolete, directly setting the ModulePermissionCollection is likely an error, change the contenst of the collection instead. The setter still exists to preserve binary compatibility without the obsolete attribute since c# will not allow only a setter to be obsolete.

Declaration

public ModulePermissionCollection ModulePermissions { get; set; }

Property Value

Type	Description
ModulePermissionCollection

| Improve this Doc View Source

ModuleSettings

ModuleInfo provides the Entity Layer for Modules.

Declaration

public Hashtable ModuleSettings { get; }

Property Value

Type	Description
Hashtable

| Improve this Doc View Source

ModuleTitle

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string ModuleTitle { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ModuleVersion

ModuleInfo provides the Entity Layer for Modules.

Declaration

public int ModuleVersion { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

OwnerPortalID

ModuleInfo provides the Entity Layer for Modules.

Declaration

public int OwnerPortalID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

PaneModuleCount

ModuleInfo provides the Entity Layer for Modules.

Declaration

public int PaneModuleCount { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

PaneModuleIndex

ModuleInfo provides the Entity Layer for Modules.

Declaration

public int PaneModuleIndex { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

PaneName

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string PaneName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ParentTab

ModuleInfo provides the Entity Layer for Modules.

Declaration

public TabInfo ParentTab { get; }

Property Value

Type	Description
TabInfo

| Improve this Doc View Source

PortalID

ModuleInfo provides the Entity Layer for Modules.

Declaration

public int PortalID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

StartDate

ModuleInfo provides the Entity Layer for Modules.

Declaration

public DateTime StartDate { get; set; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

TabModuleID

ModuleInfo provides the Entity Layer for Modules.

Declaration

public int TabModuleID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

TabModuleSettings

ModuleInfo provides the Entity Layer for Modules.

Declaration

public Hashtable TabModuleSettings { get; }

Property Value

Type	Description
Hashtable

| Improve this Doc View Source

UniqueId

ModuleInfo provides the Entity Layer for Modules.

Declaration

public Guid UniqueId { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

VersionGuid

ModuleInfo provides the Entity Layer for Modules.

Declaration

public Guid VersionGuid { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

Visibility

ModuleInfo provides the Entity Layer for Modules.

Declaration

public VisibilityState Visibility { get; set; }

Property Value

Type	Description
VisibilityState

| Improve this Doc View Source

WebSliceExpiryDate

ModuleInfo provides the Entity Layer for Modules.

Declaration

public DateTime WebSliceExpiryDate { get; set; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

WebSliceTitle

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string WebSliceTitle { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

WebSliceTTL

ModuleInfo provides the Entity Layer for Modules.

Declaration

public int WebSliceTTL { get; set; }

Property Value

Type	Description
System.Int32

Methods

| Improve this Doc View Source

Clone()

ModuleInfo provides the Entity Layer for Modules.

Declaration

public ModuleInfo Clone()

Returns

Type	Description
ModuleInfo

| Improve this Doc View Source

Fill(IDataReader)

Fills a ModuleInfo from a Data Reader.

Declaration

public override void Fill(IDataReader dr)

Parameters

Type	Name	Description
IDataReader	dr	The Data Reader to use.

Overrides

ContentItem.Fill(IDataReader)

| Improve this Doc View Source

GetEffectiveCacheMethod()

ModuleInfo provides the Entity Layer for Modules.

Declaration

public string GetEffectiveCacheMethod()

Returns

Type	Description
System.String

| Improve this Doc View Source

GetProperty(String, String, CultureInfo, UserInfo, Scope, ref Boolean)

Gets a property.

Declaration

public string GetProperty(string propertyName, string format, CultureInfo formatProvider, UserInfo accessingUser, Scope currentScope, ref bool propertyNotFound)

Parameters

Type	Name	Description
System.String	propertyName	The property name to get.
System.String	format	The format string to format the property with, or `null` to use the default format.
CultureInfo	formatProvider	The format provider (e.g. ) to use.
UserInfo	accessingUser	The user this property belongs to, UserInfo.
Scope	currentScope
System.Boolean	propertyNotFound	An out parameter that indicates if the property was not found.

Returns

Type	Description
System.String	A string with the value of the property.

| Improve this Doc View Source

Initialize(Int32)

ModuleInfo provides the Entity Layer for Modules.

Declaration

public void Initialize(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

Implements

IHydratable

IPropertyAccess

Extension Methods

JsonExtensionsWeb.ToJson(Object)