IReferenceGetSubtree Method
|
Get the subtree of the specified page in XElement format, confined to the specified depth.
Namespace:
Ingeniux.Runtime.Reference
Assembly:
IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.6.308
Syntax XElement GetSubtree(
string pageId,
int depth = 0,
bool includeUnmarkedPages = false
)
Function GetSubtree (
pageId As String,
Optional depth As Integer = 0,
Optional includeUnmarkedPages As Boolean = false
) As XElement
XElement^ GetSubtree(
String^ pageId,
int depth = 0,
bool includeUnmarkedPages = false
)
abstract GetSubtree :
pageId : string *
?depth : int *
?includeUnmarkedPages : bool
(* Defaults:
let _depth = defaultArg depth 0
let _includeUnmarkedPages = defaultArg includeUnmarkedPages false
*)
-> XElement
Parameters
- pageId
- Type: SystemString
Root page ID - depth (Optional)
- Type: SystemInt32
Depth of the subtree, default is 0 which gets the entire tree - includeUnmarkedPages (Optional)
- Type: SystemBoolean
(Optional) Whether to include unmarked pages in the tree. This defaults to false.
Return Value
Type:
XElementAn XElement tree starting at the provided root page. The returned tree is a clone of the specified page's subtree reference node.
See Also