IOutliningNode Interface
Provides the base requirements for an outlining node.
public interface IOutliningNodeProperties
Count
The count of child nodes within this outlining node.
Definition
The IOutliningNodeDefinition that was used to define the node.
IsCollapsed
Indicates whether the node is collapsed.
bool IsCollapsed { get; set; }Property Value
- bool:
trueif the node is collapsed; otherwise,false.
IsOpen
Indicates whether the outlining node is open (has no fixed end offset).
bool IsOpen { get; }Property Value
- bool:
trueif the outlining node is open (has no fixed end offset); otherwise,false.
IsRoot
Indicates whether the outlining node is a root-level node.
bool IsRoot { get; }Property Value
- bool:
trueif the outlining node is a root-level node; otherwise,false.
Remarks
A root-level node has no ParentNode.
this[int]
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
ParentNode
The IOutliningNode that is the parent of this outlining node.
SnapshotRange
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
ToTreeString(int)
Outputs the contents of the outlining node in tree form.
string ToTreeString(int indentLevel)| Parameter | Type | Description |
|---|---|---|
| indentLevel | int | The indentation level. |
Returns
- string:
A string containing the tree form of the outlining node.