IReferenceGetSiblings Method
|
The a list of references for the siblings of a given page.
Namespace:
Ingeniux.Runtime.Reference
Assembly:
IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.6.308
Syntax IEnumerable<IReferenceEntry> GetSiblings(
string pageId,
out int currentItemIndex,
bool includeUnmarkedPages = false
)
Function GetSiblings (
pageId As String,
<OutAttribute> ByRef currentItemIndex As Integer,
Optional includeUnmarkedPages As Boolean = false
) As IEnumerable(Of IReferenceEntry)
IEnumerable<IReferenceEntry^>^ GetSiblings(
String^ pageId,
[OutAttribute] int% currentItemIndex,
bool includeUnmarkedPages = false
)
abstract GetSiblings :
pageId : string *
currentItemIndex : int byref *
?includeUnmarkedPages : bool
(* Defaults:
let _includeUnmarkedPages = defaultArg includeUnmarkedPages false
*)
-> IEnumerable<IReferenceEntry>
Parameters
- pageId
- Type: SystemString
ID of the page whose siblings to retrieve - currentItemIndex
- Type: SystemInt32
Output the position of the given page among its siblings - includeUnmarkedPages (Optional)
- Type: SystemBoolean
(Optional) Whether to include unmarked siblings. This defaults to false.
Return Value
Type:
IEnumerableIReferenceEntryCollection of sibling page entries. Returns an empty collection if no siblings exist.
See Also