Class PageTreeItem

Namespace

Dynamicweb.Content.Data

Assembly

Dynamicweb.dll

The PageTreeItem class represents a page in a PageTree instance

public class PageTreeItem : IDisplayName, IPermissionLookup, IPermissionControlled

Inheritance

object

PageTreeItem

Implements

IDisplayName

IPermissionLookup

IPermissionControlled

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PageTreeItem()

Initializes a new instance of the PageTreeItem class

public PageTreeItem()

PageTreeItem(Page)

Initializes a new instance of the PageTreeItem class encapsulating parts of the data from the page argument

public PageTreeItem(Page page)

Parameters

page Page

The page that this PageTreeItem encapsulates

Properties

AreaID

Gets or sets the id of the area to which this page belongs

public int AreaID { get; set; }

Property Value

int

Children

Gets all children in the PageTree Instance

public IList<PageTreeItem> Children { get; set; }

Property Value

IList<PageTreeItem>

DisplayMode

Gets or sets the page display mode.

public DisplayMode DisplayMode { get; set; }

Property Value

DisplayMode

HasContentType

Gets or sets a value indicating if this Page has selected content type.

public bool HasContentType { get; set; }

Property Value

bool

HasEcommerceNavigation

Gets or sets a value indicating if this Page has Ecommerce navigation which is turned on.

public bool HasEcommerceNavigation { get; set; }

Property Value

bool

HasUrlProvider

Gets or sets a value indicating if this Page has URL provider.

public bool HasUrlProvider { get; set; }

Property Value

bool

ID

Gets or sets the page id of this page tree item

public int ID { get; set; }

Property Value

int

The id of this page

IsDraft

Gets or sets a value indiacting if this Page is draft

public bool IsDraft { get; set; }

Property Value

bool

IsFolder

Gets or sets a value indiacting if this Page is representing a folder

public bool IsFolder { get; set; }

Property Value

bool

IsHidden

Gets or sets a value indiacting if this Page is hidden

public bool IsHidden { get; set; }

Property Value

bool

IsPublished

Gets or sets a value indiacting if this Page is published

public bool IsPublished { get; set; }

Property Value

bool

IsShortcut

Gets or sets a value indicating if this Page is shortcut

public bool IsShortcut { get; set; }

Property Value

bool

IsSplitTest

Gets or sets a value indiacting if this Page has split test

public bool IsSplitTest { get; set; }

Property Value

bool

IsTemplate

Gets or sets a value if this page is a template

public bool IsTemplate { get; set; }

Property Value

bool

IsTemplateFolder

Gets a value indicating if this is a template folder

public bool IsTemplateFolder { get; }

Property Value

bool

IsUrlIgnoredForChildren

Gets or sets a value indicating if this Page URL does not includes in subpage URLs.

public bool IsUrlIgnoredForChildren { get; set; }

Property Value

bool

ItemId

Gets or sets the item id of this page tree item

public string ItemId { get; set; }

Property Value

string

The item id

ItemType

Gets or sets the item type of this page

public string ItemType { get; set; }

Property Value

string

Level

Gets or sets the level of this page tree item relative from the root page in a given PageTree

public int Level { get; set; }

Property Value

int

The level of this page

NavigationTag

Gets or sets a value of the Page navigation tag.

public string NavigationTag { get; set; }

Property Value

string

NumberOfSubPages

[Obsolete("Use SubpageCount instead")]
public int NumberOfSubPages { get; }

Property Value

int

Parent

Gets the parent of this PageTreeItem

public PageTreeItem Parent { get; set; }

Property Value

PageTreeItem

ParentAreaIsLanguage

Gets or sets a value if this page is in website language

public bool ParentAreaIsLanguage { get; set; }

Property Value

bool

ParentId

Gets or sets the parent page id of this page tree item

public int ParentId { get; set; }

Property Value

int

The parent id of this page

Restricted

Gets or sets a value indiacting if this Page is restricted

public bool Restricted { get; set; }

Property Value

bool

Scheduled

Gets or sets a value indiacting if this Page is scheduled

public bool Scheduled { get; set; }

Property Value

bool

Sort

Gets or sets the PageSort for this PageTreeItem indicating the sort order between items on the same PageLevel

public int Sort { get; set; }

Property Value

int

SubpageCount

Gets the number of subpages for this PageTreeItem

public int SubpageCount { get; }

Property Value

int

An integer indicating the number of sub pages under this PageTreeItem

TemplateDescription

Gets or sets the description of this page if it is a Template

public string TemplateDescription { get; set; }

Property Value

string

Title

Gets or sets the page title of this page tree item

public string Title { get; set; }

Property Value

string

The title of this page

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

GetDisplayName()

Yields a human-readable name for rendering.

public string GetDisplayName()

Returns

string

name

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.