Class Page

Namespace

Oqtane.Models

Assembly

Oqtane.Shared.dll

Describes a Page in Oqtane

public class Page : ModelBase, IAuditable, IDeletable

Inheritance

object

ModelBase

Page

Implements

IAuditable

IDeletable

Inherited Members

ModelBase.CreatedBy

ModelBase.CreatedOn

ModelBase.ModifiedBy

ModelBase.ModifiedOn

Properties

BodyContent

Content to be included in the body of the page

public string BodyContent { get; set; }

Property Value

string

DefaultContainerType

Reference to a Container which will be used for modules on this page.

public string DefaultContainerType { get; set; }

Property Value

string

DeletedBy

User who deleted this object.

public string DeletedBy { get; set; }

Property Value

string

DeletedOn

Timestamp when it was deleted.

public DateTime? DeletedOn { get; set; }

Property Value

DateTime?

EditMode

[Obsolete("The EditMode property is deprecated", false)]
[NotMapped]
public bool EditMode { get; set; }

Property Value

bool

EffectiveDate

Start of when this page is visible. See also ExpiryDate

public DateTime? EffectiveDate { get; set; }

Property Value

DateTime?

ExpiryDate

End of when this page is visible. See also EffectiveDate

public DateTime? ExpiryDate { get; set; }

Property Value

DateTime?

HasChildren

Determines if there are sub-pages. True if this page has sub-pages.

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

Property Value

bool

HeadContent

Content to be included in the head of the page

public string HeadContent { get; set; }

Property Value

string

Icon

Icon class name for this page

public string Icon { get; set; }

Property Value

string

IsClickable

Indicates if this page should be clickable in navigation menu

public bool IsClickable { get; set; }

Property Value

bool

IsDeleted

If something is deleted, this will be true.

public bool IsDeleted { get; set; }

Property Value

bool

IsNavigation

Indicates if this page should be included in navigation menu

public bool IsNavigation { get; set; }

Property Value

bool

IsPersonalizable

Indicates if page is personalizable ie. allows users to create custom versions of the page

public bool IsPersonalizable { get; set; }

Property Value

bool

LayoutType

[Obsolete("The LayoutType property is deprecated", false)]
[NotMapped]
public string LayoutType { get; set; }

Property Value

string

Level

The hierarchical level of the page

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

Property Value

int

Name

Page Name. TODO: todoc where this is used

public string Name { get; set; }

Property Value

string

Order

Sort order in the list of other sibling pages

public int Order { get; set; }

Property Value

int

PageId

Id of the Page

public int PageId { get; set; }

Property Value

int

Panes

List of Pane names for the Theme assigned to this page

[NotMapped]
public List<string> Panes { get; set; }

Property Value

List<string>

ParentId

Reference to the parent Page if it has one.

public int? ParentId { get; set; }

Property Value

int?

Path

Path of the page. TODO: todoc relative to what? site root, parent-page, domain?

public string Path { get; set; }

Property Value

string

PermissionList

List of permissions for this page

[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

Resources

List of Resource (CSS, JS) which this page needs to render properly.

[NotMapped]
public List<Resource> Resources { get; set; }

Property Value

List<Resource>

Settings

List of settings for this page

[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

ThemeType

Reference to a Theme which will be used to show this page.

public string ThemeType { get; set; }

Property Value

string

Title

Page Title which is shown in the browser tab.

public string Title { get; set; }

Property Value

string

Url

Full URL to this page. TODO: verify that this is the case - does it contain domain etc. or just from domain or alias root?

public string Url { get; set; }

Property Value

string

UserId

Reference to the user User who owns the personalized page

public int? UserId { get; set; }

Property Value

int?

Methods

Clone()

public Page Clone()

Returns

Page