Class PageHierarchicalEnumerable

A type that enables hierarchical enumeration from a specified location in a page tree. This type is a wrapper type of the PageDataCollection to support hierarchical page data source controls.

Inheritance

System.Object

PageHierarchicalEnumerable

Implements

System.Web.UI.IHierarchicalEnumerable

System.Collections.IEnumerable

IHierarchyParent

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 PageHierarchicalEnumerable : IHierarchicalEnumerable, IEnumerable, IHierarchyParent

Remarks

Supports the PageDataSource control and provides an interface for hierarchical controls to extract hierarchical information from page data

Constructors

PageHierarchicalEnumerable(PageDataCollection, IHierarchicalPageDataSource)

Initializes a new instance of the PageHierarchicalEnumerable class with a set of pages.

Declaration

public PageHierarchicalEnumerable(PageDataCollection pages, IHierarchicalPageDataSource dataSource)

Parameters

Type	Name	Description
PageDataCollection	pages	The pages.
IHierarchicalPageDataSource	dataSource	The associated data source.

PageHierarchicalEnumerable(PageDataCollection, IHierarchicalPageDataSource, Int32)

Initializes a new instance of the PageHierarchicalEnumerable class with a set of pages with a given indent level.

Declaration

public PageHierarchicalEnumerable(PageDataCollection pages, IHierarchicalPageDataSource dataSource, int indent)

Parameters

Type	Name	Description
PageDataCollection	pages	The pages.
IHierarchicalPageDataSource	dataSource	The associated data source.
System.Int32	indent	The indent level.

PageHierarchicalEnumerable(PageReference, IHierarchicalPageDataSource)

Initializes a new instance of the PageHierarchicalEnumerable class for a parent page.

Declaration

public PageHierarchicalEnumerable(PageReference page, IHierarchicalPageDataSource dataSource)

Parameters

Type	Name	Description
PageReference	page	The root page.
IHierarchicalPageDataSource	dataSource	The associated data source.

PageHierarchicalEnumerable(PageReference, IHierarchicalPageDataSource, Int32)

Initializes a new instance of the PageHierarchicalEnumerable class for a specified parent page with a given indent level.

Declaration

public PageHierarchicalEnumerable(PageReference page, IHierarchicalPageDataSource dataSource, int indent)

Parameters

Type	Name	Description
PageReference	page	The root page.
IHierarchicalPageDataSource	dataSource	The associated data source.
System.Int32	indent	The indent.

Properties

Indent

Gets the indent level of the pages in the PageHierarchicalEnumerable instance.

Declaration

public int Indent { get; }

Property Value

Type	Description
System.Int32	The indent level.

Pages

Gets the collection of pages associated with this PageHierarchicalEnumerable.

Declaration

public PageDataCollection Pages { get; }

Property Value

Type	Description
PageDataCollection	The pages.

Methods

GetEnumerator()

Gets the enumerator.

Declaration

public IEnumerator<PageHierarchyData> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<PageHierarchyData>	A System.Collections.Generic.IEnumerator<T>.

GetHierarchyData(Object)

Returns a hierarchical data item for the specified enumerated item.

Declaration

public IHierarchyData GetHierarchyData(object enumeratedItem)

Parameters

Type	Name	Description
System.Object	enumeratedItem	The System.Object for which to return an System.Web.UI.IHierarchyData.

Returns

Type	Description
System.Web.UI.IHierarchyData	An System.Web.UI.IHierarchyData instance that represents the System.Object passed to the System.Web.UI.IHierarchicalEnumerable.GetHierarchyData(System.Object) method.