Take the community feedback survey now.

AI OnAI Off

Class PageHierarchyData

Supports the PageDataSource control and provides an interface for hierarchical controls to extract hierarchical data from a PageData object.

Inheritance
System.Object
PageHierarchyData
Implements
System.Web.UI.IHierarchyData
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Web.WebControls
Assembly: EPiServer.Cms.AspNet.dll
Version: 11.20.7
Syntax
public class PageHierarchyData : IHierarchyData

Constructors

PageHierarchyData()

Initializes a new instance of the PageHierarchyData class.

Declaration
public PageHierarchyData()

PageHierarchyData(IPageSource)

Initializes a new instance of the PageHierarchyData class.

Declaration
public PageHierarchyData(IPageSource pageSource)
Parameters
Type Name Description
IPageSource pageSource

The page source to use for misc page requests.

PageHierarchyData(PageData, IHierarchicalPageDataSource)

Initializes a new instance of the PageHierarchyData class.

Declaration
public PageHierarchyData(PageData page, IHierarchicalPageDataSource dataSource)
Parameters
Type Name Description
PageData page

The PageData for the current node.
IHierarchicalPageDataSource dataSource

The associated PageDataSource instance.

PageHierarchyData(PageData, IHierarchicalPageDataSource, IPageSource)

Initializes a new instance of the PageHierarchyData class.

Declaration
public PageHierarchyData(PageData page, IHierarchicalPageDataSource dataSource, IPageSource pageSource)
Parameters
Type Name Description
PageData page

The PageData for the current node.
IHierarchicalPageDataSource dataSource

The associated PageDataSource instance.
IPageSource pageSource

The page source to use for misc page requests.

PageHierarchyData(PageData, IHierarchicalPageDataSource, Int32)

Initializes a new instance of the PageHierarchyData class.

Declaration
public PageHierarchyData(PageData page, IHierarchicalPageDataSource dataSource, int indent)
Parameters
Type Name Description
PageData page

The PageData for the current node.
IHierarchicalPageDataSource dataSource

The associated PageDataSource instance.
System.Int32 indent

The indent level of the page in the current tree structure.

PageHierarchyData(PageData, IHierarchicalPageDataSource, Int32, IPageSource)

Initializes a new instance of the PageHierarchyData class.

Declaration
public PageHierarchyData(PageData page, IHierarchicalPageDataSource dataSource, int indent, IPageSource pageSource)
Parameters
Type Name Description
PageData page

The PageData for the current node.
IHierarchicalPageDataSource dataSource

The associated PageDataSource instance.
System.Int32 indent

The indent level of the page in the current tree structure.
IPageSource pageSource

The page source to use for misc page requests.

Properties

HasChildren

Indicates whether the hierarchical data node that the System.Web.UI.IHierarchyData object represents has any child nodes.

Declaration
public bool HasChildren { get; }
Property Value
Type Description
System.Boolean

Indent

Gets the indent level of the page in the current tree structure.

Declaration
public int Indent { get; }
Property Value
Type Description
System.Int32

The indent.

Item

Gets the hierarchical data node that the System.Web.UI.IHierarchyData object represents.

Declaration
public object Item { get; }
Property Value
Type Description
System.Object

Page

Gets the PageData represented by the PageHierarchyData instance.

Declaration
public PageData Page { get; }
Property Value
Type Description
PageData

The PageData instance.

Path

Gets the hierarchical path of the node.

Declaration
public string Path { get; }
Property Value
Type Description
System.String

Type

Gets the name of the type of System.Object contained in the System.Web.UI.IHierarchyData.Item property.

Declaration
public string Type { get; }
Property Value
Type Description
System.String

Methods

GetChildren()

Gets an enumeration object that represents all the child nodes of the current hierarchical node.

Declaration
public IHierarchicalEnumerable GetChildren()
Returns
Type Description
System.Web.UI.IHierarchicalEnumerable

An System.Web.UI.IHierarchicalEnumerable collection of child nodes of the current hierarchical node.

GetParent()

Gets an enumeration object that represents the parent node of the current hierarchical node.

Declaration
public IHierarchyData GetParent()
Returns
Type Description
System.Web.UI.IHierarchyData

An System.Web.UI.IHierarchicalEnumerable object that represents the parent node of the current hierarchical node.

Implements

System.Web.UI.IHierarchyData

Extension Methods