Class CSharpSyntaxTree

Inheritance

object

SyntaxTree

CSharpSyntaxTree

Inherited Members

SyntaxTree.EmptyDiagnosticOptions

SyntaxTree.TryGetText(out SourceText)

SyntaxTree.GetText(CancellationToken)

SyntaxTree.GetTextAsync(CancellationToken)

SyntaxTree.TryGetRoot(out SyntaxNode)

SyntaxTree.GetReference(SyntaxNode)

SyntaxTree.WithRootAndOptions(SyntaxNode, ParseOptions)

SyntaxTree.WithFilePath(string)

SyntaxTree.WithDiagnosticOptions(ImmutableDictionary<string, ReportDiagnostic>)

SyntaxTree.ToString()

SyntaxTree.FilePath

SyntaxTree.HasCompilationUnitRoot

SyntaxTree.DiagnosticOptions

SyntaxTree.Length

SyntaxTree.Encoding

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Microsoft.CodeAnalysis.CSharp

Assembly: Microsoft.CodeAnalysis.CSharp.dll

Syntax

public abstract class CSharpSyntaxTree : SyntaxTree

Constructors

CSharpSyntaxTree()

Declaration

public CSharpSyntaxTree()

Properties

Options

Declaration

public abstract CSharpParseOptions Options { get; }

Property Value

Type	Description
CSharpParseOptions

OptionsCore

Declaration

protected override ParseOptions OptionsCore { get; }

Property Value

Type	Description
ParseOptions

Overrides

SyntaxTree.OptionsCore

Methods

CloneNodeAsRoot<T>(T)

Declaration

protected T CloneNodeAsRoot<T>(T node) where T : CSharpSyntaxNode

Parameters

Type	Name	Description
T	node

Returns

Type	Description
T

Type Parameters

Name	Description
T

Create(CSharpSyntaxNode, CSharpParseOptions?, string?, Encoding?)

Declaration

public static SyntaxTree Create(CSharpSyntaxNode root, CSharpParseOptions? options = null, string? path = "", Encoding? encoding = null)

Parameters

Type	Name	Description
CSharpSyntaxNode	root
CSharpParseOptions	options
string	path
Encoding	encoding

Returns

Type	Description
SyntaxTree

GetChangedSpans(SyntaxTree)

Declaration

public override IList<TextSpan> GetChangedSpans(SyntaxTree oldTree)

Parameters

Type	Name	Description
SyntaxTree	oldTree

Returns

Type	Description
IList<TextSpan>

Overrides

SyntaxTree.GetChangedSpans(SyntaxTree)

GetChanges(SyntaxTree)

Declaration

public override IList<TextChange> GetChanges(SyntaxTree oldTree)

Parameters

Type	Name	Description
SyntaxTree	oldTree

Returns

Type	Description
IList<TextChange>

Overrides

SyntaxTree.GetChanges(SyntaxTree)

GetCompilationUnitRoot(CancellationToken)

Declaration

public CompilationUnitSyntax GetCompilationUnitRoot(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
CompilationUnitSyntax

GetDiagnostics(SyntaxNode)

Declaration

public override IEnumerable<Diagnostic> GetDiagnostics(SyntaxNode node)

Parameters

Type	Name	Description
SyntaxNode	node

Returns

Type	Description
IEnumerable<Diagnostic>

Overrides

SyntaxTree.GetDiagnostics(SyntaxNode)

GetDiagnostics(SyntaxNodeOrToken)

Declaration

public override IEnumerable<Diagnostic> GetDiagnostics(SyntaxNodeOrToken nodeOrToken)

Parameters

Type	Name	Description
SyntaxNodeOrToken	nodeOrToken

Returns

Type	Description
IEnumerable<Diagnostic>

Overrides

SyntaxTree.GetDiagnostics(SyntaxNodeOrToken)

GetDiagnostics(SyntaxToken)

Declaration

public override IEnumerable<Diagnostic> GetDiagnostics(SyntaxToken token)

Parameters

Type	Name	Description
SyntaxToken	token

Returns

Type	Description
IEnumerable<Diagnostic>

Overrides

SyntaxTree.GetDiagnostics(SyntaxToken)

GetDiagnostics(SyntaxTrivia)

Declaration

public override IEnumerable<Diagnostic> GetDiagnostics(SyntaxTrivia trivia)

Parameters

Type	Name	Description
SyntaxTrivia	trivia

Returns

Type	Description
IEnumerable<Diagnostic>

Overrides

SyntaxTree.GetDiagnostics(SyntaxTrivia)

GetDiagnostics(CancellationToken)

Declaration

public override IEnumerable<Diagnostic> GetDiagnostics(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
IEnumerable<Diagnostic>

Overrides

SyntaxTree.GetDiagnostics(CancellationToken)

GetLineMappings(CancellationToken)

Declaration

public override IEnumerable<LineMapping> GetLineMappings(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
IEnumerable<LineMapping>

Overrides

SyntaxTree.GetLineMappings(CancellationToken)

GetLineSpan(TextSpan, CancellationToken)

Declaration

public override FileLinePositionSpan GetLineSpan(TextSpan span, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TextSpan	span
CancellationToken	cancellationToken

Returns

Type	Description
FileLinePositionSpan

Overrides

SyntaxTree.GetLineSpan(TextSpan, CancellationToken)

GetLineVisibility(int, CancellationToken)

Declaration

public override LineVisibility GetLineVisibility(int position, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	position
CancellationToken	cancellationToken

Returns

Type	Description
LineVisibility

Overrides

SyntaxTree.GetLineVisibility(int, CancellationToken)

GetLocation(TextSpan)

Declaration

public override Location GetLocation(TextSpan span)

Parameters

Type	Name	Description
TextSpan	span

Returns

Type	Description
Location

Overrides

SyntaxTree.GetLocation(TextSpan)

GetMappedLineSpan(TextSpan, CancellationToken)

Declaration

public override FileLinePositionSpan GetMappedLineSpan(TextSpan span, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TextSpan	span
CancellationToken	cancellationToken

Returns

Type	Description
FileLinePositionSpan

Overrides

SyntaxTree.GetMappedLineSpan(TextSpan, CancellationToken)

GetRoot(CancellationToken)

Declaration

public abstract CSharpSyntaxNode GetRoot(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
CSharpSyntaxNode

GetRootAsync(CancellationToken)

Declaration

public virtual Task<CSharpSyntaxNode> GetRootAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<CSharpSyntaxNode>

GetRootAsyncCore(CancellationToken)

Declaration

protected override Task<SyntaxNode> GetRootAsyncCore(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<SyntaxNode>

Overrides

SyntaxTree.GetRootAsyncCore(CancellationToken)

GetRootCore(CancellationToken)

Declaration

protected override SyntaxNode GetRootCore(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
SyntaxNode

Overrides

SyntaxTree.GetRootCore(CancellationToken)

HasHiddenRegions()

Declaration

public override bool HasHiddenRegions()

Returns

Type	Description
bool

Overrides

SyntaxTree.HasHiddenRegions()

IsEquivalentTo(SyntaxTree, bool)

Declaration

public override bool IsEquivalentTo(SyntaxTree tree, bool topLevel = false)

Parameters

Type	Name	Description
SyntaxTree	tree
bool	topLevel

Returns

Type	Description
bool

Overrides

SyntaxTree.IsEquivalentTo(SyntaxTree, bool)

ParseText(SourceText, CSharpParseOptions?, string, CancellationToken)

Declaration

public static SyntaxTree ParseText(SourceText text, CSharpParseOptions? options = null, string path = "", CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SourceText	text
CSharpParseOptions	options
string	path
CancellationToken	cancellationToken

Returns

Type	Description
SyntaxTree

ParseText(string, CSharpParseOptions?, string, Encoding?, CancellationToken)

Declaration

public static SyntaxTree ParseText(string text, CSharpParseOptions? options = null, string path = "", Encoding? encoding = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	text
CSharpParseOptions	options
string	path
Encoding	encoding
CancellationToken	cancellationToken

Returns

Type	Description
SyntaxTree

TryGetRoot(out CSharpSyntaxNode?)

Declaration

public abstract bool TryGetRoot(out CSharpSyntaxNode? root)

Parameters

Type	Name	Description
CSharpSyntaxNode	root

Returns

Type	Description
bool

TryGetRootCore(out SyntaxNode?)

Declaration

protected override bool TryGetRootCore(out SyntaxNode? root)

Parameters

Type	Name	Description
SyntaxNode	root

Returns

Type	Description
bool

Overrides

SyntaxTree.TryGetRootCore(out SyntaxNode?)

WithChangedText(SourceText)

Declaration

public override SyntaxTree WithChangedText(SourceText newText)

Parameters

Type	Name	Description
SourceText	newText

Returns

Type	Description
SyntaxTree

Overrides

SyntaxTree.WithChangedText(SourceText)

Extension Methods

CSharpExtensions.GetCompilationUnitRoot(SyntaxTree, CancellationToken)