Class CSharpSyntaxNode

Inheritance

object

SyntaxNode

CSharpSyntaxNode

AccessorDeclarationSyntax

AccessorListSyntax

AllowsConstraintSyntax

AnonymousObjectMemberDeclaratorSyntax

ArgumentSyntax

ArrayRankSpecifierSyntax

ArrowExpressionClauseSyntax

AttributeArgumentListSyntax

AttributeArgumentSyntax

AttributeListSyntax

AttributeSyntax

AttributeTargetSpecifierSyntax

BaseArgumentListSyntax

BaseCrefParameterListSyntax

BaseExpressionColonSyntax

BaseListSyntax

BaseParameterListSyntax

BaseParameterSyntax

BaseTypeSyntax

CatchClauseSyntax

CatchDeclarationSyntax

CatchFilterClauseSyntax

CollectionElementSyntax

CompilationUnitSyntax

ConstructorInitializerSyntax

CrefParameterSyntax

CrefSyntax

ElseClauseSyntax

EqualsValueClauseSyntax

ExplicitInterfaceSpecifierSyntax

ExpressionOrPatternSyntax

ExternAliasDirectiveSyntax

FinallyClauseSyntax

FunctionPointerCallingConventionSyntax

FunctionPointerParameterListSyntax

FunctionPointerUnmanagedCallingConventionListSyntax

FunctionPointerUnmanagedCallingConventionSyntax

InterpolatedStringContentSyntax

InterpolationAlignmentClauseSyntax

InterpolationFormatClauseSyntax

JoinIntoClauseSyntax

LineDirectivePositionSyntax

MemberDeclarationSyntax

NameEqualsSyntax

OrderingSyntax

PositionalPatternClauseSyntax

PropertyPatternClauseSyntax

QueryBodySyntax

QueryClauseSyntax

QueryContinuationSyntax

SelectOrGroupClauseSyntax

StatementSyntax

StructuredTriviaSyntax

SubpatternSyntax

SwitchExpressionArmSyntax

SwitchLabelSyntax

SwitchSectionSyntax

TupleElementSyntax

TypeArgumentListSyntax

TypeParameterConstraintClauseSyntax

TypeParameterConstraintSyntax

TypeParameterListSyntax

TypeParameterSyntax

UsingDirectiveSyntax

VariableDeclarationSyntax

VariableDeclaratorSyntax

VariableDesignationSyntax

WhenClauseSyntax

XmlAttributeSyntax

XmlElementEndTagSyntax

XmlElementStartTagSyntax

XmlNameSyntax

XmlNodeSyntax

XmlPrefixSyntax

Implements

IFormattable

Inherited Members

SyntaxNode.GetRed<T>(ref T, int)

SyntaxNode.GetRedAtZero<T>(ref T)

SyntaxNode.ToString()

SyntaxNode.ToFullString()

SyntaxNode.WriteTo(TextWriter)

SyntaxNode.GetText(Encoding, SourceHashAlgorithm)

SyntaxNode.IsEquivalentTo(SyntaxNode)

SyntaxNode.IsIncrementallyIdenticalTo(SyntaxNode)

SyntaxNode.IsPartOfStructuredTrivia()

SyntaxNode.ContainsDirective(int)

SyntaxNode.Contains(SyntaxNode)

SyntaxNode.GetReference()

SyntaxNode.ChildNodesAndTokens()

SyntaxNode.ChildThatContainsPosition(int)

SyntaxNode.ChildNodes()

SyntaxNode.Ancestors(bool)

SyntaxNode.AncestorsAndSelf(bool)

SyntaxNode.FirstAncestorOrSelf<TNode>(Func<TNode, bool>, bool)

SyntaxNode.FirstAncestorOrSelf<TNode, TArg>(Func<TNode, TArg, bool>, TArg, bool)

SyntaxNode.DescendantNodes(Func<SyntaxNode, bool>, bool)

SyntaxNode.DescendantNodes(TextSpan, Func<SyntaxNode, bool>, bool)

SyntaxNode.DescendantNodesAndSelf(Func<SyntaxNode, bool>, bool)

SyntaxNode.DescendantNodesAndSelf(TextSpan, Func<SyntaxNode, bool>, bool)

SyntaxNode.DescendantNodesAndTokens(Func<SyntaxNode, bool>, bool)

SyntaxNode.DescendantNodesAndTokens(TextSpan, Func<SyntaxNode, bool>, bool)

SyntaxNode.DescendantNodesAndTokensAndSelf(Func<SyntaxNode, bool>, bool)

SyntaxNode.DescendantNodesAndTokensAndSelf(TextSpan, Func<SyntaxNode, bool>, bool)

SyntaxNode.FindNode(TextSpan, bool, bool)

SyntaxNode.ChildTokens()

SyntaxNode.DescendantTokens(Func<SyntaxNode, bool>, bool)

SyntaxNode.DescendantTokens(TextSpan, Func<SyntaxNode, bool>, bool)

SyntaxNode.DescendantTrivia(Func<SyntaxNode, bool>, bool)

SyntaxNode.DescendantTrivia(TextSpan, Func<SyntaxNode, bool>, bool)

SyntaxNode.HasAnnotations(string)

SyntaxNode.HasAnnotations(IEnumerable<string>)

SyntaxNode.HasAnnotation(SyntaxAnnotation)

SyntaxNode.GetAnnotations(string)

SyntaxNode.GetAnnotations(IEnumerable<string>)

SyntaxNode.GetAnnotatedNodesAndTokens(string)

SyntaxNode.GetAnnotatedNodesAndTokens(params string[])

SyntaxNode.GetAnnotatedNodesAndTokens(SyntaxAnnotation)

SyntaxNode.GetAnnotatedNodes(SyntaxAnnotation)

SyntaxNode.GetAnnotatedNodes(string)

SyntaxNode.GetAnnotatedTokens(SyntaxAnnotation)

SyntaxNode.GetAnnotatedTokens(string)

SyntaxNode.GetAnnotatedTrivia(string)

SyntaxNode.GetAnnotatedTrivia(params string[])

SyntaxNode.GetAnnotatedTrivia(SyntaxAnnotation)

SyntaxNode.CopyAnnotationsTo<T>(T)

SyntaxNode.IsEquivalentTo(SyntaxNode, bool)

SyntaxNode.SerializeTo(Stream, CancellationToken)

SyntaxNode.FindTokenCore(int, bool)

SyntaxNode.FindTokenCore(int, Func<SyntaxTrivia, bool>)

SyntaxNode.FindTriviaCore(int, bool)

SyntaxNode.RawKind

SyntaxNode.KindText

SyntaxNode.SyntaxTree

SyntaxNode.FullSpan

SyntaxNode.Span

SyntaxNode.SpanStart

SyntaxNode.IsMissing

SyntaxNode.IsStructuredTrivia

SyntaxNode.HasStructuredTrivia

SyntaxNode.ContainsSkippedText

SyntaxNode.ContainsDiagnostics

SyntaxNode.ContainsDirectives

SyntaxNode.HasLeadingTrivia

SyntaxNode.HasTrailingTrivia

SyntaxNode.Parent

SyntaxNode.ParentTrivia

SyntaxNode.ContainsAnnotations

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 CSharpSyntaxNode : SyntaxNode, IFormattable

Properties

Language

Declaration

public override string Language { get; }

Property Value

Type	Description
string

Overrides

SyntaxNode.Language

SyntaxTreeCore

Declaration

protected override SyntaxTree SyntaxTreeCore { get; }

Property Value

Type	Description
SyntaxTree

Overrides

SyntaxNode.SyntaxTreeCore

Methods

Accept(CSharpSyntaxVisitor)

Declaration

public abstract void Accept(CSharpSyntaxVisitor visitor)

Parameters

Type	Name	Description
CSharpSyntaxVisitor	visitor

Accept<TResult>(CSharpSyntaxVisitor<TResult>)

Declaration

public abstract TResult? Accept<TResult>(CSharpSyntaxVisitor<TResult> visitor)

Parameters

Type	Name	Description
CSharpSyntaxVisitor<TResult>	visitor

Returns

Type	Description
TResult

Type Parameters

Name	Description
TResult

DeserializeFrom(Stream, CancellationToken)

Declaration

[Obsolete("Syntax serialization support is no longer supported", true)]
public static SyntaxNode DeserializeFrom(Stream stream, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Stream	stream
CancellationToken	cancellationToken

Returns

Type	Description
SyntaxNode

EquivalentToCore(SyntaxNode)

Declaration

protected override bool EquivalentToCore(SyntaxNode other)

Parameters

Type	Name	Description
SyntaxNode	other

Returns

Type	Description
bool

Overrides

SyntaxNode.EquivalentToCore(SyntaxNode)

FindToken(int, bool)

Declaration

public SyntaxToken FindToken(int position, bool findInsideTrivia = false)

Parameters

Type	Name	Description
int	position
bool	findInsideTrivia

Returns

Type	Description
SyntaxToken

FindTrivia(int, bool)

Declaration

public SyntaxTrivia FindTrivia(int position, bool findInsideTrivia = false)

Parameters

Type	Name	Description
int	position
bool	findInsideTrivia

Returns

Type	Description
SyntaxTrivia

FindTrivia(int, Func<SyntaxTrivia, bool>)

Declaration

public SyntaxTrivia FindTrivia(int position, Func<SyntaxTrivia, bool> stepInto)

Parameters

Type	Name	Description
int	position
Func<SyntaxTrivia, bool>	stepInto

Returns

Type	Description
SyntaxTrivia

GetDiagnostics()

Declaration

public IEnumerable<Diagnostic> GetDiagnostics()

Returns

Type	Description
IEnumerable<Diagnostic>

GetFirstDirective(Func<DirectiveTriviaSyntax, bool>?)

Declaration

public DirectiveTriviaSyntax? GetFirstDirective(Func<DirectiveTriviaSyntax, bool>? predicate = null)

Parameters

Type	Name	Description
Func<DirectiveTriviaSyntax, bool>	predicate

Returns

Type	Description
DirectiveTriviaSyntax

GetFirstToken(bool, bool, bool, bool)

Declaration

public SyntaxToken GetFirstToken(bool includeZeroWidth = false, bool includeSkipped = false, bool includeDirectives = false, bool includeDocumentationComments = false)

Parameters

Type	Name	Description
bool	includeZeroWidth
bool	includeSkipped
bool	includeDirectives
bool	includeDocumentationComments

Returns

Type	Description
SyntaxToken

GetLastDirective(Func<DirectiveTriviaSyntax, bool>?)

Declaration

public DirectiveTriviaSyntax? GetLastDirective(Func<DirectiveTriviaSyntax, bool>? predicate = null)

Parameters

Type	Name	Description
Func<DirectiveTriviaSyntax, bool>	predicate

Returns

Type	Description
DirectiveTriviaSyntax

GetLastToken(bool, bool, bool, bool)

Declaration

public SyntaxToken GetLastToken(bool includeZeroWidth = false, bool includeSkipped = false, bool includeDirectives = false, bool includeDocumentationComments = false)

Parameters

Type	Name	Description
bool	includeZeroWidth
bool	includeSkipped
bool	includeDirectives
bool	includeDocumentationComments

Returns

Type	Description
SyntaxToken

GetLeadingTrivia()

Declaration

public SyntaxTriviaList GetLeadingTrivia()

Returns

Type	Description
SyntaxTriviaList

GetLocation()

Declaration

public Location GetLocation()

Returns

Type	Description
Location

GetTrailingTrivia()

Declaration

public SyntaxTriviaList GetTrailingTrivia()

Returns

Type	Description
SyntaxTriviaList

InsertNodesInListCore(SyntaxNode, IEnumerable<SyntaxNode>, bool)

Declaration

protected override SyntaxNode InsertNodesInListCore(SyntaxNode nodeInList, IEnumerable<SyntaxNode> nodesToInsert, bool insertBefore)

Parameters

Type	Name	Description
SyntaxNode	nodeInList
IEnumerable<SyntaxNode>	nodesToInsert
bool	insertBefore

Returns

Type	Description
SyntaxNode

Overrides

SyntaxNode.InsertNodesInListCore(SyntaxNode, IEnumerable<SyntaxNode>, bool)

InsertTokensInListCore(SyntaxToken, IEnumerable<SyntaxToken>, bool)

Declaration

protected override SyntaxNode InsertTokensInListCore(SyntaxToken originalToken, IEnumerable<SyntaxToken> newTokens, bool insertBefore)

Parameters

Type	Name	Description
SyntaxToken	originalToken
IEnumerable<SyntaxToken>	newTokens
bool	insertBefore

Returns

Type	Description
SyntaxNode

Overrides

SyntaxNode.InsertTokensInListCore(SyntaxToken, IEnumerable<SyntaxToken>, bool)

InsertTriviaInListCore(SyntaxTrivia, IEnumerable<SyntaxTrivia>, bool)

Declaration

protected override SyntaxNode InsertTriviaInListCore(SyntaxTrivia originalTrivia, IEnumerable<SyntaxTrivia> newTrivia, bool insertBefore)

Parameters

Type	Name	Description
SyntaxTrivia	originalTrivia
IEnumerable<SyntaxTrivia>	newTrivia
bool	insertBefore

Returns

Type	Description
SyntaxNode

Overrides

SyntaxNode.InsertTriviaInListCore(SyntaxTrivia, IEnumerable<SyntaxTrivia>, bool)

IsEquivalentToCore(SyntaxNode, bool)

Declaration

protected override bool IsEquivalentToCore(SyntaxNode node, bool topLevel = false)

Parameters

Type	Name	Description
SyntaxNode	node
bool	topLevel

Returns

Type	Description
bool

Overrides

SyntaxNode.IsEquivalentToCore(SyntaxNode, bool)

Kind()

Declaration

public SyntaxKind Kind()

Returns

Type	Description
SyntaxKind

NormalizeWhitespaceCore(string, string, bool)

Declaration

protected override SyntaxNode NormalizeWhitespaceCore(string indentation, string eol, bool elasticTrivia)

Parameters

Type	Name	Description
string	indentation
string	eol
bool	elasticTrivia

Returns

Type	Description
SyntaxNode

Overrides

SyntaxNode.NormalizeWhitespaceCore(string, string, bool)

RemoveNodesCore(IEnumerable<SyntaxNode>, SyntaxRemoveOptions)

Declaration

protected override SyntaxNode? RemoveNodesCore(IEnumerable<SyntaxNode> nodes, SyntaxRemoveOptions options)

Parameters

Type	Name	Description
IEnumerable<SyntaxNode>	nodes
SyntaxRemoveOptions	options

Returns

Type	Description
SyntaxNode

Overrides

SyntaxNode.RemoveNodesCore(IEnumerable<SyntaxNode>, SyntaxRemoveOptions)

ReplaceCore<TNode>(IEnumerable<TNode>?, Func<TNode, TNode, SyntaxNode>?, IEnumerable<SyntaxToken>?, Func<SyntaxToken, SyntaxToken, SyntaxToken>?, IEnumerable<SyntaxTrivia>?, Func<SyntaxTrivia, SyntaxTrivia, SyntaxTrivia>?)

Declaration

protected override SyntaxNode ReplaceCore<TNode>(IEnumerable<TNode>? nodes = null, Func<TNode, TNode, SyntaxNode>? computeReplacementNode = null, IEnumerable<SyntaxToken>? tokens = null, Func<SyntaxToken, SyntaxToken, SyntaxToken>? computeReplacementToken = null, IEnumerable<SyntaxTrivia>? trivia = null, Func<SyntaxTrivia, SyntaxTrivia, SyntaxTrivia>? computeReplacementTrivia = null) where TNode : SyntaxNode

Parameters

Type	Name	Description
IEnumerable<TNode>	nodes
Func<TNode, TNode, SyntaxNode>	computeReplacementNode
IEnumerable<SyntaxToken>	tokens
Func<SyntaxToken, SyntaxToken, SyntaxToken>	computeReplacementToken
IEnumerable<SyntaxTrivia>	trivia
Func<SyntaxTrivia, SyntaxTrivia, SyntaxTrivia>	computeReplacementTrivia

Returns

Type	Description
SyntaxNode

Type Parameters

Name	Description
TNode

Overrides

SyntaxNode.ReplaceCore<TNode>(IEnumerable<TNode>, Func<TNode, TNode, SyntaxNode>, IEnumerable<SyntaxToken>, Func<SyntaxToken, SyntaxToken, SyntaxToken>, IEnumerable<SyntaxTrivia>, Func<SyntaxTrivia, SyntaxTrivia, SyntaxTrivia>)

ReplaceNodeInListCore(SyntaxNode, IEnumerable<SyntaxNode>)

Declaration

protected override SyntaxNode ReplaceNodeInListCore(SyntaxNode originalNode, IEnumerable<SyntaxNode> replacementNodes)

Parameters

Type	Name	Description
SyntaxNode	originalNode
IEnumerable<SyntaxNode>	replacementNodes

Returns

Type	Description
SyntaxNode

Overrides

SyntaxNode.ReplaceNodeInListCore(SyntaxNode, IEnumerable<SyntaxNode>)

ReplaceTokenInListCore(SyntaxToken, IEnumerable<SyntaxToken>)

Declaration

protected override SyntaxNode ReplaceTokenInListCore(SyntaxToken originalToken, IEnumerable<SyntaxToken> newTokens)

Parameters

Type	Name	Description
SyntaxToken	originalToken
IEnumerable<SyntaxToken>	newTokens

Returns

Type	Description
SyntaxNode

Overrides

SyntaxNode.ReplaceTokenInListCore(SyntaxToken, IEnumerable<SyntaxToken>)

ReplaceTriviaInListCore(SyntaxTrivia, IEnumerable<SyntaxTrivia>)

Declaration

protected override SyntaxNode ReplaceTriviaInListCore(SyntaxTrivia originalTrivia, IEnumerable<SyntaxTrivia> newTrivia)

Parameters

Type	Name	Description
SyntaxTrivia	originalTrivia
IEnumerable<SyntaxTrivia>	newTrivia

Returns

Type	Description
SyntaxNode

Overrides

SyntaxNode.ReplaceTriviaInListCore(SyntaxTrivia, IEnumerable<SyntaxTrivia>)

Implements

IFormattable

Extension Methods

CSharpExtensions.GetFirstDirective(SyntaxNode, Func<DirectiveTriviaSyntax, bool>?)

CSharpExtensions.GetLastDirective(SyntaxNode, Func<DirectiveTriviaSyntax, bool>?)

CSharpExtensions.Kind(SyntaxNode)

SyntaxFacts.TryGetInferredMemberName(SyntaxNode)

CSharpExtensions.ContainsDirective(SyntaxNode, SyntaxKind)

CSharpExtensions.IsKind(SyntaxNode?, SyntaxKind)