Click or drag to resize

IContentItemDescendantIDsWithMaxDepth Method


Retrieves metadata of the descendants of this page within the given depth limit.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax
IEnumerable<PageHierarchyAndID> DescendantIDsWithMaxDepth(
	out int count,
	int maxDepth,
	int maxCount = -1
)

Parameters

count
Type: SystemInt32
Total count of all descendant pages within the given depth limit..
maxDepth
Type: SystemInt32
The depth limit of descendants, relative of this page's hierarchy level.
maxCount (Optional)
Type: SystemInt32
The node limit of descendants.

Return Value

Type: IEnumerablePageHierarchyAndID
Collection of metadata of descendant pages within the depth limit
Remarks
A maxDepth of 0 means to retrieve all descendants.
Examples
A maxDepth value of 2 means to retrieve the descendants that are within 2 levels below the given page.
See Also