Share via

DocumentSymbol Class

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.LanguageServer.Protocol
Assembly:
Microsoft.VisualStudio.LanguageServer.Protocol.dll
Package:
Microsoft.VisualStudio.LanguageServer.Protocol v17.2.8

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.

See the Language Server Protocol specification for additional information.

public ref class DocumentSymbol
[System.Runtime.Serialization.DataContract]
public class DocumentSymbol
[<System.Runtime.Serialization.DataContract>]
type DocumentSymbol = class
Public Class DocumentSymbol
Inheritance
Object
DocumentSymbol
Attributes
DataContractAttribute

Constructors

DocumentSymbol()

Properties

Children

Gets or sets the children of this symbol, e.g. properties of a class.
Deprecated

Gets or sets a value indicating whether this symbol is deprecated.
Detail

Gets or sets more detail for this symbol, e.g the signature of a function.
Kind

Gets or sets the SymbolKind of this symbol.
Name

Gets or sets the name of this symbol.
Range

Gets or sets 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.
SelectionRange

Gets or sets 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.

Applies to