Interface IHierarchicalPageDataSource
Defines the contract for how hierarchical loading of pages is performed in the PageTreeData and the PageDataSource controls.
Namespace: EPiServer.Web.WebControls
Assembly: EPiServer.Cms.AspNet.dll
Version: 11.20.7Syntax
public interface IHierarchicalPageDataSourceProperties
AccessLevel
Gets the page access level for datasource.
Declaration
AccessLevel AccessLevel { get; }Property Value
| Type | Description |
|---|---|
| AccessLevel | The page access level. |
EvaluateHasChildren
Gets a value indicating if the HasChildren property should be determined for the associated PageHierarchyData instance. In some tree rendering situations it can cost a lot, performance wise, to perform this evaluation in which case this property can be implemeneted to return false.
Declaration
bool EvaluateHasChildren { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
GetFilteredChildren(PageReference)
Returns a filtered PageDataCollection that represents the child pages of the provided PageReference.
Declaration
PageDataCollection GetFilteredChildren(PageReference pageLink)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | Represents the node for which children are to be loaded. |
Returns
| Type | Description |
|---|---|
| PageDataCollection | A PageDataCollection of the filtered children. |
HierarchicalSelect(String)
Performs a selection based on a specified path. A blank path denotes the root of the page hierarchy.
Declaration
PageHierarchicalEnumerable HierarchicalSelect(string viewPath)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | viewPath | The path to load. |
Returns
| Type | Description |
|---|---|
| PageHierarchicalEnumerable | A PageHierarchicalEnumerable that can enumerate the loaded pages. |
Remarks
If the provided path is an empty string it denotes the root of the page hierarchy. All other paths represent a Page ID.
IsRoot(PageData)
Calculates whether a PageData object corresponds to the hierarchical root.
Declaration
bool IsRoot(PageData page)Parameters
| Type | Name | Description |
|---|---|---|
| PageData | page | The PageData instance to compare. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if page is the same as the hierarchical root, otherwise false. |
