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.3.169
Syntax IEnumerable<PageHierarchyAndID> DescendantIDsWithMaxDepth(
out int count,
int maxDepth,
int maxCount = -1
)
Function DescendantIDsWithMaxDepth (
<OutAttribute> ByRef count As Integer,
maxDepth As Integer,
Optional maxCount As Integer = -1
) As IEnumerable(Of PageHierarchyAndID)
IEnumerable<PageHierarchyAndID^>^ DescendantIDsWithMaxDepth(
[OutAttribute] int% count,
int maxDepth,
int maxCount = -1
)
abstract DescendantIDsWithMaxDepth :
count : int byref *
maxDepth : int *
?maxCount : int
(* Defaults:
let _maxCount = defaultArg maxCount -1
*)
-> IEnumerable<PageHierarchyAndID>
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:
IEnumerablePageHierarchyAndIDCollection 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