IPageDescendantsWithMaxDepth Method
|
Retrieves 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<IPage> DescendantsWithMaxDepth(
out int count,
int maxDepth,
int pageSize = -1,
int startIndex = -1
)
Function DescendantsWithMaxDepth (
<OutAttribute> ByRef count As Integer,
maxDepth As Integer,
Optional pageSize As Integer = -1,
Optional startIndex As Integer = -1
) As IEnumerable(Of IPage)
IEnumerable<IPage^>^ DescendantsWithMaxDepth(
[OutAttribute] int% count,
int maxDepth,
int pageSize = -1,
int startIndex = -1
)
abstract DescendantsWithMaxDepth :
count : int byref *
maxDepth : int *
?pageSize : int *
?startIndex : int
(* Defaults:
let _pageSize = defaultArg pageSize -1
let _startIndex = defaultArg startIndex -1
*)
-> IEnumerable<IPage>
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.
Examples A maxDepth value of 2 means to retrieve the descendants that are within 2 levels below the given page.
Remarks A maxDepth of 0 means to retrieve all descendants.
- pageSize (Optional)
- Type: SystemInt32
Number of entries to return. If not provided, returns all entries. - startIndex (Optional)
- Type: SystemInt32
Starting index of entries. If not provided, starts from the first entry.
Return Value
Type:
IEnumerableIPageCollection of descendant pages within the depth limit
See Also Reference
[!:Ingeniux.CMS.IPage.DescendantsIDsWithMaxDepth]