In This Article

TokenOutliningSourceBase Class

Provides an abstract IOutliningSource implementation that constructs outlining node data based on token data returned by a language's lexer.

public abstract class TokenOutliningSourceBase : IOutliningSource
Inheritance:
object object
Implements:
IOutliningSource

Constructors

TokenOutliningSourceBase(ITextSnapshot)

Initializes an instance of the class.

protected TokenOutliningSourceBase(ITextSnapshot snapshot)
Parameter Type Description
snapshot ITextSnapshot

The ITextSnapshot to use for this outlining source.

Methods

GetNodeAction(ref int, out IOutliningNodeDefinition?)

Returns information about the action to take when incrementally updating automatic outlining for a particular offset.

public virtual OutliningNodeAction GetNodeAction(ref int offset, out IOutliningNodeDefinition? definition)
Parameter Type Description
offset int

The offset to examine. For improved incremental outlining performance, it can be modified to indicate the next meaningful offset for the source.

definition IOutliningNodeDefinition

If the node action indicated is a start or end, an IOutliningNodeDefinition describing the related node must be returned.

Returns

OutliningNodeAction

GetNodeActionForToken(IToken, out IOutliningNodeDefinition?)

Returns information about the action to take when incrementally updating automatic outlining for a particular token.

protected abstract OutliningNodeAction GetNodeActionForToken(IToken token, out IOutliningNodeDefinition? definition)
Parameter Type Description
token IToken

The IToken to examine.

definition IOutliningNodeDefinition

If the node action indicated is a start or end, an IOutliningNodeDefinition describing the related node must be returned.

Returns

OutliningNodeAction

Inherited Members

Extension Methods