IOutliningNodeDefinition Interface
Provides the base requirements for a definition used to create an outlining node.
public interface IOutliningNodeDefinition : IKeyedObject
Properties
HasEndDelimiter
Gets whether the outlining node ends using a delimiter.
bool HasEndDelimiter { get; }
Property Value
- bool:
true
if the outlining node ends using a delimiter; otherwise,false
.
Remarks
This property can be set to false
to hint to the outlining manager that the node might be properly closed even though it doesn't have an end delimiter.
See Also
IsCollapsible
Gets whether the outlining node is capable of being collapsed.
bool IsCollapsible { get; }
Property Value
- bool:
true
if the outlining node is capable of being collapsed; otherwise,false
.
See Also
IsDefaultCollapsed
Gets whether the outlining node is collapsed by default.
bool IsDefaultCollapsed { get; }
Property Value
- bool:
true
if the outlining node is collapsed by default; otherwise,false
.
Remarks
Pre-processor region nodes are examples of nodes that are generally collapsed by default.
See Also
IsImplementation
Gets whether the outlining node represents some sort of member implementation that should be auto-collapsed when collapsing to definitions.
bool IsImplementation { get; }
Property Value
- bool:
true
if the outlining node represents some sort of member implementation; otherwise,false
.
See Also
Methods
GetCollapsedContent(IOutliningNode)
Returns the content that should be displayed when the outlining node is collapsed.
object GetCollapsedContent(IOutliningNode node)
Parameter | Type | Description |
---|---|---|
node | IOutliningNode | The IOutliningNode, based on this definition, for which content is requested. |
Returns
- object:
The content that should be displayed when the outlining node is collapsed.
Remarks
Only string-based content is currently supported. This method can be implemented to generate unique collapsed content for a particular node.