Click or drag to resize

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
)

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: XElement
An XElement tree starting at the provided root page. The returned tree is a clone of the specified page's subtree reference node.
See Also