IReferenceGetAncestors Method

Get the page references for all the ancestors of a given page.

Namespace: Ingeniux.Runtime.Reference
Assembly: IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.6.308

Syntax

IEnumerable<IReferenceEntry> GetAncestors(
	string pageId,
	string stopAncestorPageId,
	bool includeUnmarkedPages = false
)

Function GetAncestors ( 
	pageId As String,
	stopAncestorPageId As String,
	Optional includeUnmarkedPages As Boolean = false
) As IEnumerable(Of IReferenceEntry)

IEnumerable<IReferenceEntry^>^ GetAncestors(
	String^ pageId, 
	String^ stopAncestorPageId, 
	bool includeUnmarkedPages = false
)

abstract GetAncestors : 
        pageId : string * 
        stopAncestorPageId : string * 
        ?includeUnmarkedPages : bool 
(* Defaults:
        let _includeUnmarkedPages = defaultArg includeUnmarkedPages false
*)
-> IEnumerable<IReferenceEntry>

Parameters

pageId: Type: SystemString
ID of the page whose ancestors to retrieve
stopAncestorPageId: Type: SystemString
ID of the ancestor page to stop at
includeUnmarkedPages (Optional): Type: SystemBoolean
(Optional) Whether to include unmarked pages. This defaults to false.

Return Value

Type: IEnumerableIReferenceEntry
Collection of ancestor page entries, starting from the page itself moving up the ancestor chain. Returns an empty collection if no parent page exists.

Reference

IReference Interface

Ingeniux.Runtime.Reference Namespace

IReferenceGetChildren(String, Boolean)

IReferenceGetSiblings(String, Int32, Boolean)

IReferenceAddLanguageSpecificTextSet("LST1A7C4E99_0?cpp=::|nu=.");GetAncestors Method

Parameters

Return Value

Reference

IReferenceGetAncestors Method