Class SyntaxTree

Inheritance
object
SyntaxTree
CSharpSyntaxTree
Inherited Members
Namespace: Microsoft.CodeAnalysis
Assembly: Microsoft.CodeAnalysis.dll
Syntax
public abstract class SyntaxTree

Constructors

SyntaxTree()

Declaration
protected SyntaxTree()

Fields

EmptyDiagnosticOptions

Declaration
protected static readonly ImmutableDictionary<string, ReportDiagnostic> EmptyDiagnosticOptions
Field Value
Type Description
ImmutableDictionary<string, ReportDiagnostic>

Properties

DiagnosticOptions

Declaration
[Obsolete("Obsolete due to performance problems, use CompilationOptions.SyntaxTreeOptionsProvider instead", false)]
public virtual ImmutableDictionary<string, ReportDiagnostic> DiagnosticOptions { get; }
Property Value
Type Description
ImmutableDictionary<string, ReportDiagnostic>

Encoding

Declaration
public abstract Encoding? Encoding { get; }
Property Value
Type Description
Encoding

FilePath

Declaration
public abstract string FilePath { get; }
Property Value
Type Description
string

HasCompilationUnitRoot

Declaration
public abstract bool HasCompilationUnitRoot { get; }
Property Value
Type Description
bool

Length

Declaration
public abstract int Length { get; }
Property Value
Type Description
int

Options

Declaration
public ParseOptions Options { get; }
Property Value
Type Description
ParseOptions

OptionsCore

Declaration
protected abstract ParseOptions OptionsCore { get; }
Property Value
Type Description
ParseOptions

Methods

GetChangedSpans(SyntaxTree)

Declaration
public abstract IList<TextSpan> GetChangedSpans(SyntaxTree syntaxTree)
Parameters
Type Name Description
SyntaxTree syntaxTree
Returns
Type Description
IList<TextSpan>

GetChanges(SyntaxTree)

Declaration
public abstract IList<TextChange> GetChanges(SyntaxTree oldTree)
Parameters
Type Name Description
SyntaxTree oldTree
Returns
Type Description
IList<TextChange>

GetDiagnostics(SyntaxNode)

Declaration
public abstract IEnumerable<Diagnostic> GetDiagnostics(SyntaxNode node)
Parameters
Type Name Description
SyntaxNode node
Returns
Type Description
IEnumerable<Diagnostic>

GetDiagnostics(SyntaxNodeOrToken)

Declaration
public abstract IEnumerable<Diagnostic> GetDiagnostics(SyntaxNodeOrToken nodeOrToken)
Parameters
Type Name Description
SyntaxNodeOrToken nodeOrToken
Returns
Type Description
IEnumerable<Diagnostic>

GetDiagnostics(SyntaxToken)

Declaration
public abstract IEnumerable<Diagnostic> GetDiagnostics(SyntaxToken token)
Parameters
Type Name Description
SyntaxToken token
Returns
Type Description
IEnumerable<Diagnostic>

GetDiagnostics(SyntaxTrivia)

Declaration
public abstract IEnumerable<Diagnostic> GetDiagnostics(SyntaxTrivia trivia)
Parameters
Type Name Description
SyntaxTrivia trivia
Returns
Type Description
IEnumerable<Diagnostic>

GetDiagnostics(CancellationToken)

Declaration
public abstract IEnumerable<Diagnostic> GetDiagnostics(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
IEnumerable<Diagnostic>

GetLineMappings(CancellationToken)

Declaration
public abstract IEnumerable<LineMapping> GetLineMappings(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
IEnumerable<LineMapping>

GetLineSpan(TextSpan, CancellationToken)

Declaration
public abstract FileLinePositionSpan GetLineSpan(TextSpan span, CancellationToken cancellationToken = default)
Parameters
Type Name Description
TextSpan span
CancellationToken cancellationToken
Returns
Type Description
FileLinePositionSpan

GetLineVisibility(int, CancellationToken)

Declaration
public virtual LineVisibility GetLineVisibility(int position, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int position
CancellationToken cancellationToken
Returns
Type Description
LineVisibility

GetLocation(TextSpan)

Declaration
public abstract Location GetLocation(TextSpan span)
Parameters
Type Name Description
TextSpan span
Returns
Type Description
Location

GetMappedLineSpan(TextSpan, CancellationToken)

Declaration
public abstract FileLinePositionSpan GetMappedLineSpan(TextSpan span, CancellationToken cancellationToken = default)
Parameters
Type Name Description
TextSpan span
CancellationToken cancellationToken
Returns
Type Description
FileLinePositionSpan

GetReference(SyntaxNode)

Declaration
public abstract SyntaxReference GetReference(SyntaxNode node)
Parameters
Type Name Description
SyntaxNode node
Returns
Type Description
SyntaxReference

GetRoot(CancellationToken)

Declaration
public SyntaxNode GetRoot(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
SyntaxNode

GetRootAsync(CancellationToken)

Declaration
public Task<SyntaxNode> GetRootAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<SyntaxNode>

GetRootAsyncCore(CancellationToken)

Declaration
protected abstract Task<SyntaxNode> GetRootAsyncCore(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<SyntaxNode>

GetRootCore(CancellationToken)

Declaration
protected abstract SyntaxNode GetRootCore(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
SyntaxNode

GetText(CancellationToken)

Declaration
public abstract SourceText GetText(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
SourceText

GetTextAsync(CancellationToken)

Declaration
public virtual Task<SourceText> GetTextAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<SourceText>

HasHiddenRegions()

Declaration
public abstract bool HasHiddenRegions()
Returns
Type Description
bool

IsEquivalentTo(SyntaxTree, bool)

Declaration
public abstract bool IsEquivalentTo(SyntaxTree tree, bool topLevel = false)
Parameters
Type Name Description
SyntaxTree tree
bool topLevel
Returns
Type Description
bool

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

TryGetRoot(out SyntaxNode?)

Declaration
public bool TryGetRoot(out SyntaxNode? root)
Parameters
Type Name Description
SyntaxNode root
Returns
Type Description
bool

TryGetRootCore(out SyntaxNode?)

Declaration
protected abstract bool TryGetRootCore(out SyntaxNode? root)
Parameters
Type Name Description
SyntaxNode root
Returns
Type Description
bool

TryGetText(out SourceText?)

Declaration
public abstract bool TryGetText(out SourceText? text)
Parameters
Type Name Description
SourceText text
Returns
Type Description
bool

WithChangedText(SourceText)

Declaration
public abstract SyntaxTree WithChangedText(SourceText newText)
Parameters
Type Name Description
SourceText newText
Returns
Type Description
SyntaxTree

WithDiagnosticOptions(ImmutableDictionary<string, ReportDiagnostic>)

Declaration
[Obsolete("Obsolete due to performance problems, use CompilationOptions.SyntaxTreeOptionsProvider instead", false)]
public virtual SyntaxTree WithDiagnosticOptions(ImmutableDictionary<string, ReportDiagnostic> options)
Parameters
Type Name Description
ImmutableDictionary<string, ReportDiagnostic> options
Returns
Type Description
SyntaxTree

WithFilePath(string)

Declaration
public abstract SyntaxTree WithFilePath(string path)
Parameters
Type Name Description
string path
Returns
Type Description
SyntaxTree

WithRootAndOptions(SyntaxNode, ParseOptions)

Declaration
public abstract SyntaxTree WithRootAndOptions(SyntaxNode root, ParseOptions options)
Parameters
Type Name Description
SyntaxNode root
ParseOptions options
Returns
Type Description
SyntaxTree