Class DocumentSymbol

Namespace

NMF.AnyText

Assembly

NMF.AnyText.Core.dll

Represents programming constructs like variables, classes, interfaces etc. that appear in a document.Document symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range, e.g.the range of an identifier. Analogous to the LspTypes DocumentSymbol interface.

public class DocumentSymbol

Inheritance

object

DocumentSymbol

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Children

Children of this symbol, e.g. properties of a class.

public IEnumerable<DocumentSymbol> Children { get; set; }

Property Value

IEnumerable<DocumentSymbol>

Detail

More detail for this symbol, e.g the signature of a function.

public string Detail { get; set; }

Property Value

string

Kind

The kind of this symbol.

public SymbolKind Kind { get; set; }

Property Value

SymbolKind

Name

The name of this symbol. Will be displayed in the user interface and therefore must not be an empty string or a string only consisting of white spaces.

public string Name { get; set; }

Property Value

string

Range

The range enclosing this symbol not including leading/trailing whitespace but everything else like comments.This information is typically used to determine if the clients cursor is inside the symbol to reveal in the symbol in the UI.

public ParseRange Range { get; set; }

Property Value

ParseRange

SelectionRange

The range that should be selected and revealed when this symbol is being picked, e.g.the name of a function. Must be contained by the Range.

public ParseRange SelectionRange { get; set; }

Property Value

ParseRange

Tags

Tags for this document symbol.

public SymbolTag[] Tags { get; set; }

Property Value

SymbolTag[]