IOutliningNode Interface
Provides the base requirements for an outlining node.
public interface IOutliningNode
Properties
Count
Gets the count of child nodes within this outlining node.
Definition
Gets the IOutliningNodeDefinition that was used to define the node.
IOutliningNodeDefinition Definition { get; }
Property Value
- IOutliningNodeDefinition:
The IOutliningNodeDefinition that was used to define the node.
IsCollapsed
Gets or sets whether the node is collapsed.
bool IsCollapsed { get; set; }
Property Value
- bool:
true
if the node is collapsed; otherwise,false
.
IsOpen
Gets whether the outlining node is open (has no fixed end offset).
bool IsOpen { get; }
Property Value
- bool:
true
if the outlining node is open (has no fixed end offset); otherwise,false
.
IsRoot
Gets whether the outlining node is a root-level node.
bool IsRoot { get; }
Property Value
- bool:
true
if the outlining node is a root-level node; otherwise,false
.
Remarks
A root-level node has no ParentNode.
this[int]
Gets the child IOutliningNode at the specified index.
IOutliningNode this[int index] { get; }
Parameter | Type | Description |
---|---|---|
index | int | The zero-based index of the child IOutliningNode. |
Property Value
- IOutliningNode:
The child IOutliningNode at the specified index.
ParentNode
Gets the IOutliningNode that is the parent of this outlining node.
IOutliningNode ParentNode { get; }
Property Value
- IOutliningNode:
The IOutliningNode that is the parent of this outlining node.
SnapshotRange
Gets the TextSnapshotRange that specifies the offset range of this outlining node.
TextSnapshotRange SnapshotRange { get; }
Property Value
- TextSnapshotRange:
The TextSnapshotRange that specifies the offset range of this outlining node.
Methods
FindNodeRecursive(int)
Returns a descendant IOutliningNode that contains the specified offset.
IOutliningNode FindNodeRecursive(int offset)
Parameter | Type | Description |
---|---|---|
offset | int | The offset for which to search. |
Returns
- IOutliningNode:
A descendant IOutliningNode that contains the specified offset.
ToTreeString(int)
Outputs the contents of the outlining node in tree form.