Table of Contents

Class Module

Namespace
Oqtane.Models
Assembly
Oqtane.Shared.dll

Describes a Module Instance which will be shown on a page. This is different from a ModuleDefinition which describes a Module.

public class Module : ModelBase, IAuditable
Inheritance
object
Module
Implements
Inherited Members

Properties

Actions

Optional mapping of Url actions to a component

[NotMapped]
public string Actions { get; set; }

Property Value

string

AllPages

Determines if this module should be shown on all pages of the current Site

public bool AllPages { get; set; }

Property Value

bool

ContainerType

The container for the pagemodule instance

[NotMapped]
public string ContainerType { get; set; }

Property Value

string

ControlTitle

An optional title for the component

[NotMapped]
public string ControlTitle { get; set; }

Property Value

string

DeletedBy 

[NotMapped]
public string DeletedBy { get; set; }

Property Value

string

DeletedOn 

[NotMapped]
public DateTime? DeletedOn { get; set; }

Property Value

DateTime?

EffectiveDate

Start of when this module is visible. See also ExpiryDate

[NotMapped]
public DateTime? EffectiveDate { get; set; }

Property Value

DateTime?

ExpiryDate

End of when this module is visible. See also EffectiveDate

[NotMapped]
public DateTime? ExpiryDate { get; set; }

Property Value

DateTime?

IsDeleted 

[NotMapped]
public bool IsDeleted { get; set; }

Property Value

bool

ModuleDefinition

Reference to the ModuleDefinition used for this module.

[NotMapped]
public ModuleDefinition ModuleDefinition { get; set; }

Property Value

ModuleDefinition

ModuleDefinitionName

Reference to the ModuleDefinition

public string ModuleDefinitionName { get; set; }

Property Value

string

ModuleId

The ID of this instance

public int ModuleId { get; set; }

Property Value

int

ModuleType

Stores the type name for the module component being rendered

[NotMapped]
public string ModuleType { get; set; }

Property Value

string

Order

The order of the pagemodule instance within the Pane

[NotMapped]
public int Order { get; set; }

Property Value

int

PageId

Reference to the Page this module is on.

[NotMapped]
public int PageId { get; set; }

Property Value

int

PageModuleId

The id of the PageModule instance

[NotMapped]
public int PageModuleId { get; set; }

Property Value

int

Pane

The pane where this pagemodule instance will be injected on the page

[NotMapped]
public string Pane { get; set; }

Property Value

string

PaneModuleCount

The number of modules in a pane

[NotMapped]
public int PaneModuleCount { get; set; }

Property Value

int

PaneModuleIndex

The position of the module instance in a pane

[NotMapped]
public int PaneModuleIndex { get; set; }

Property Value

int

PermissionList

list of permissions for this module

[NotMapped]
public List<Permission> PermissionList { get; set; }

Property Value

List<Permission>

Permissions 

[Obsolete("The Permissions property is deprecated. Use PermissionList instead", false)]
[NotMapped]
[JsonIgnore]
public string Permissions { get; set; }

Property Value

string

Prerender

Optionally specify id the component should be prerendered (overrides the Site setting)

[NotMapped]
public bool? Prerender { get; set; }

Property Value

bool?

RenderId

A unique id to help determine if a component should be rendered

[NotMapped]
public Guid RenderId { get; set; }

Property Value

Guid

RenderMode

Optionally specify the render mode for the component (overrides the Site setting)

[NotMapped]
public string RenderMode { get; set; }

Property Value

string

SecurityAccessLevel

The minimum access level to view the component being rendered

[NotMapped]
public SecurityAccessLevel SecurityAccessLevel { get; set; }

Property Value

SecurityAccessLevel

Settings

List of settings for this module

[NotMapped]
public Dictionary<string, string> Settings { get; set; }

Property Value

Dictionary<string, string>

SiteId

Reference to the Site

public int SiteId { get; set; }

Property Value

int

Title

Title of the pagemodule instance

[NotMapped]
public string Title { get; set; }

Property Value

string

UseAdminContainer

Optionally indicate if a compoent should not be rendered with the default modal admin container

[NotMapped]
public bool UseAdminContainer { get; set; }

Property Value

bool

Methods

Clone() 

public Module Clone()

Returns

Module
Edit this page