Class SyntaxNodeExtensions

Inheritance

object

SyntaxNodeExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Microsoft.CodeAnalysis

Assembly: Microsoft.CodeAnalysis.dll

Syntax

public static class SyntaxNodeExtensions

Methods

GetCurrentNode<TNode>(SyntaxNode, TNode)

Declaration

public static TNode? GetCurrentNode<TNode>(this SyntaxNode root, TNode node) where TNode : SyntaxNode

Parameters

Type	Name	Description
SyntaxNode	root
TNode	node

Returns

Type	Description
TNode

Type Parameters

Name	Description
TNode

GetCurrentNodes<TNode>(SyntaxNode, IEnumerable<TNode>)

Declaration

public static IEnumerable<TNode> GetCurrentNodes<TNode>(this SyntaxNode root, IEnumerable<TNode> nodes) where TNode : SyntaxNode

Parameters

Type	Name	Description
SyntaxNode	root
IEnumerable<TNode>	nodes

Returns

Type	Description
IEnumerable<TNode>

Type Parameters

Name	Description
TNode

GetCurrentNodes<TNode>(SyntaxNode, TNode)

Declaration

public static IEnumerable<TNode> GetCurrentNodes<TNode>(this SyntaxNode root, TNode node) where TNode : SyntaxNode

Parameters

Type	Name	Description
SyntaxNode	root
TNode	node

Returns

Type	Description
IEnumerable<TNode>

Type Parameters

Name	Description
TNode

InsertNodesAfter<TRoot>(TRoot, SyntaxNode, IEnumerable<SyntaxNode>)

Declaration

public static TRoot InsertNodesAfter<TRoot>(this TRoot root, SyntaxNode nodeInList, IEnumerable<SyntaxNode> newNodes) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxNode	nodeInList
IEnumerable<SyntaxNode>	newNodes

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

InsertNodesBefore<TRoot>(TRoot, SyntaxNode, IEnumerable<SyntaxNode>)

Declaration

public static TRoot InsertNodesBefore<TRoot>(this TRoot root, SyntaxNode nodeInList, IEnumerable<SyntaxNode> newNodes) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxNode	nodeInList
IEnumerable<SyntaxNode>	newNodes

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

InsertTokensAfter<TRoot>(TRoot, SyntaxToken, IEnumerable<SyntaxToken>)

Declaration

public static TRoot InsertTokensAfter<TRoot>(this TRoot root, SyntaxToken tokenInList, IEnumerable<SyntaxToken> newTokens) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxToken	tokenInList
IEnumerable<SyntaxToken>	newTokens

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

InsertTokensBefore<TRoot>(TRoot, SyntaxToken, IEnumerable<SyntaxToken>)

Declaration

public static TRoot InsertTokensBefore<TRoot>(this TRoot root, SyntaxToken tokenInList, IEnumerable<SyntaxToken> newTokens) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxToken	tokenInList
IEnumerable<SyntaxToken>	newTokens

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

InsertTriviaAfter<TRoot>(TRoot, SyntaxTrivia, IEnumerable<SyntaxTrivia>)

Declaration

public static TRoot InsertTriviaAfter<TRoot>(this TRoot root, SyntaxTrivia trivia, IEnumerable<SyntaxTrivia> newTrivia) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxTrivia	trivia
IEnumerable<SyntaxTrivia>	newTrivia

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

InsertTriviaBefore<TRoot>(TRoot, SyntaxTrivia, IEnumerable<SyntaxTrivia>)

Declaration

public static TRoot InsertTriviaBefore<TRoot>(this TRoot root, SyntaxTrivia trivia, IEnumerable<SyntaxTrivia> newTrivia) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxTrivia	trivia
IEnumerable<SyntaxTrivia>	newTrivia

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

NormalizeWhitespace<TNode>(TNode, string, bool)

Declaration

public static TNode NormalizeWhitespace<TNode>(this TNode node, string indentation, bool elasticTrivia) where TNode : SyntaxNode

Parameters

Type	Name	Description
TNode	node
string	indentation
bool	elasticTrivia

Returns

Type	Description
TNode

Type Parameters

Name	Description
TNode

NormalizeWhitespace<TNode>(TNode, string, string, bool)

Declaration

public static TNode NormalizeWhitespace<TNode>(this TNode node, string indentation = "    ", string eol = "\r\n", bool elasticTrivia = false) where TNode : SyntaxNode

Parameters

Type	Name	Description
TNode	node
string	indentation
string	eol
bool	elasticTrivia

Returns

Type	Description
TNode

Type Parameters

Name	Description
TNode

RemoveNode<TRoot>(TRoot, SyntaxNode, SyntaxRemoveOptions)

Declaration

public static TRoot? RemoveNode<TRoot>(this TRoot root, SyntaxNode node, SyntaxRemoveOptions options) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxNode	node
SyntaxRemoveOptions	options

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

RemoveNodes<TRoot>(TRoot, IEnumerable<SyntaxNode>, SyntaxRemoveOptions)

Declaration

public static TRoot? RemoveNodes<TRoot>(this TRoot root, IEnumerable<SyntaxNode> nodes, SyntaxRemoveOptions options) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
IEnumerable<SyntaxNode>	nodes
SyntaxRemoveOptions	options

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

ReplaceNode<TRoot>(TRoot, SyntaxNode, SyntaxNode)

Declaration

public static TRoot ReplaceNode<TRoot>(this TRoot root, SyntaxNode oldNode, SyntaxNode newNode) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxNode	oldNode
SyntaxNode	newNode

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

ReplaceNode<TRoot>(TRoot, SyntaxNode, IEnumerable<SyntaxNode>)

Declaration

public static TRoot ReplaceNode<TRoot>(this TRoot root, SyntaxNode oldNode, IEnumerable<SyntaxNode> newNodes) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxNode	oldNode
IEnumerable<SyntaxNode>	newNodes

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

ReplaceNodes<TRoot, TNode>(TRoot, IEnumerable<TNode>, Func<TNode, TNode, SyntaxNode>)

Declaration

public static TRoot ReplaceNodes<TRoot, TNode>(this TRoot root, IEnumerable<TNode> nodes, Func<TNode, TNode, SyntaxNode> computeReplacementNode) where TRoot : SyntaxNode where TNode : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
IEnumerable<TNode>	nodes
Func<TNode, TNode, SyntaxNode>	computeReplacementNode

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot
TNode

ReplaceSyntax<TRoot>(TRoot, IEnumerable<SyntaxNode>?, Func<SyntaxNode, SyntaxNode, SyntaxNode>?, IEnumerable<SyntaxToken>?, Func<SyntaxToken, SyntaxToken, SyntaxToken>?, IEnumerable<SyntaxTrivia>?, Func<SyntaxTrivia, SyntaxTrivia, SyntaxTrivia>?)

Declaration

public static TRoot ReplaceSyntax<TRoot>(this TRoot root, IEnumerable<SyntaxNode>? nodes, Func<SyntaxNode, SyntaxNode, SyntaxNode>? computeReplacementNode, IEnumerable<SyntaxToken>? tokens, Func<SyntaxToken, SyntaxToken, SyntaxToken>? computeReplacementToken, IEnumerable<SyntaxTrivia>? trivia, Func<SyntaxTrivia, SyntaxTrivia, SyntaxTrivia>? computeReplacementTrivia) where TRoot : SyntaxNode

Parameters

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

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

ReplaceToken<TRoot>(TRoot, SyntaxToken, SyntaxToken)

Declaration

public static TRoot ReplaceToken<TRoot>(this TRoot root, SyntaxToken oldToken, SyntaxToken newToken) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxToken	oldToken
SyntaxToken	newToken

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

ReplaceToken<TRoot>(TRoot, SyntaxToken, IEnumerable<SyntaxToken>)

Declaration

public static TRoot ReplaceToken<TRoot>(this TRoot root, SyntaxToken tokenInList, IEnumerable<SyntaxToken> newTokens) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxToken	tokenInList
IEnumerable<SyntaxToken>	newTokens

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

ReplaceTokens<TRoot>(TRoot, IEnumerable<SyntaxToken>, Func<SyntaxToken, SyntaxToken, SyntaxToken>)

Declaration

public static TRoot ReplaceTokens<TRoot>(this TRoot root, IEnumerable<SyntaxToken> tokens, Func<SyntaxToken, SyntaxToken, SyntaxToken> computeReplacementToken) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
IEnumerable<SyntaxToken>	tokens
Func<SyntaxToken, SyntaxToken, SyntaxToken>	computeReplacementToken

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

ReplaceTrivia<TRoot>(TRoot, SyntaxTrivia, SyntaxTrivia)

Declaration

public static TRoot ReplaceTrivia<TRoot>(this TRoot root, SyntaxTrivia trivia, SyntaxTrivia newTrivia) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxTrivia	trivia
SyntaxTrivia	newTrivia

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

ReplaceTrivia<TRoot>(TRoot, SyntaxTrivia, IEnumerable<SyntaxTrivia>)

Declaration

public static TRoot ReplaceTrivia<TRoot>(this TRoot root, SyntaxTrivia oldTrivia, IEnumerable<SyntaxTrivia> newTrivia) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxTrivia	oldTrivia
IEnumerable<SyntaxTrivia>	newTrivia

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

ReplaceTrivia<TRoot>(TRoot, IEnumerable<SyntaxTrivia>, Func<SyntaxTrivia, SyntaxTrivia, SyntaxTrivia>)

Declaration

public static TRoot ReplaceTrivia<TRoot>(this TRoot root, IEnumerable<SyntaxTrivia> trivia, Func<SyntaxTrivia, SyntaxTrivia, SyntaxTrivia> computeReplacementTrivia) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
IEnumerable<SyntaxTrivia>	trivia
Func<SyntaxTrivia, SyntaxTrivia, SyntaxTrivia>	computeReplacementTrivia

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

TrackNodes<TRoot>(TRoot, params SyntaxNode[])

Declaration

public static TRoot TrackNodes<TRoot>(this TRoot root, params SyntaxNode[] nodes) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
SyntaxNode[]	nodes

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

TrackNodes<TRoot>(TRoot, IEnumerable<SyntaxNode>)

Declaration

public static TRoot TrackNodes<TRoot>(this TRoot root, IEnumerable<SyntaxNode> nodes) where TRoot : SyntaxNode

Parameters

Type	Name	Description
TRoot	root
IEnumerable<SyntaxNode>	nodes

Returns

Type	Description
TRoot

Type Parameters

Name	Description
TRoot

WithLeadingTrivia<TSyntax>(TSyntax, SyntaxTriviaList)

Declaration

public static TSyntax WithLeadingTrivia<TSyntax>(this TSyntax node, SyntaxTriviaList trivia) where TSyntax : SyntaxNode

Parameters

Type	Name	Description
TSyntax	node
SyntaxTriviaList	trivia

Returns

Type	Description
TSyntax

Type Parameters

Name	Description
TSyntax

WithLeadingTrivia<TSyntax>(TSyntax, params SyntaxTrivia[]?)

Declaration

public static TSyntax WithLeadingTrivia<TSyntax>(this TSyntax node, params SyntaxTrivia[]? trivia) where TSyntax : SyntaxNode

Parameters

Type	Name	Description
TSyntax	node
SyntaxTrivia[]	trivia

Returns

Type	Description
TSyntax

Type Parameters

Name	Description
TSyntax

WithLeadingTrivia<TSyntax>(TSyntax, IEnumerable<SyntaxTrivia>?)

Declaration

public static TSyntax WithLeadingTrivia<TSyntax>(this TSyntax node, IEnumerable<SyntaxTrivia>? trivia) where TSyntax : SyntaxNode

Parameters

Type	Name	Description
TSyntax	node
IEnumerable<SyntaxTrivia>	trivia

Returns

Type	Description
TSyntax

Type Parameters

Name	Description
TSyntax

WithTrailingTrivia<TSyntax>(TSyntax, SyntaxTriviaList)

Declaration

public static TSyntax WithTrailingTrivia<TSyntax>(this TSyntax node, SyntaxTriviaList trivia) where TSyntax : SyntaxNode

Parameters

Type	Name	Description
TSyntax	node
SyntaxTriviaList	trivia

Returns

Type	Description
TSyntax

Type Parameters

Name	Description
TSyntax

WithTrailingTrivia<TSyntax>(TSyntax, params SyntaxTrivia[]?)

Declaration

public static TSyntax WithTrailingTrivia<TSyntax>(this TSyntax node, params SyntaxTrivia[]? trivia) where TSyntax : SyntaxNode

Parameters

Type	Name	Description
TSyntax	node
SyntaxTrivia[]	trivia

Returns

Type	Description
TSyntax

Type Parameters

Name	Description
TSyntax

WithTrailingTrivia<TSyntax>(TSyntax, IEnumerable<SyntaxTrivia>?)

Declaration

public static TSyntax WithTrailingTrivia<TSyntax>(this TSyntax node, IEnumerable<SyntaxTrivia>? trivia) where TSyntax : SyntaxNode

Parameters

Type	Name	Description
TSyntax	node
IEnumerable<SyntaxTrivia>	trivia

Returns

Type	Description
TSyntax

Type Parameters

Name	Description
TSyntax

WithTriviaFrom<TSyntax>(TSyntax, SyntaxNode)

Declaration

public static TSyntax WithTriviaFrom<TSyntax>(this TSyntax syntax, SyntaxNode node) where TSyntax : SyntaxNode

Parameters

Type	Name	Description
TSyntax	syntax
SyntaxNode	node

Returns

Type	Description
TSyntax

Type Parameters

Name	Description
TSyntax

WithoutLeadingTrivia<TSyntax>(TSyntax)

Declaration

public static TSyntax WithoutLeadingTrivia<TSyntax>(this TSyntax node) where TSyntax : SyntaxNode

Parameters

Type	Name	Description
TSyntax	node

Returns

Type	Description
TSyntax

Type Parameters

Name	Description
TSyntax

WithoutTrailingTrivia<TSyntax>(TSyntax)

Declaration

public static TSyntax WithoutTrailingTrivia<TSyntax>(this TSyntax node) where TSyntax : SyntaxNode

Parameters

Type	Name	Description
TSyntax	node

Returns

Type	Description
TSyntax

Type Parameters

Name	Description
TSyntax

WithoutTrivia(SyntaxToken)

Declaration

public static SyntaxToken WithoutTrivia(this SyntaxToken token)

Parameters

Type	Name	Description
SyntaxToken	token

Returns

Type	Description
SyntaxToken

WithoutTrivia<TSyntax>(TSyntax)

Declaration

public static TSyntax WithoutTrivia<TSyntax>(this TSyntax syntax) where TSyntax : SyntaxNode

Parameters

Type	Name	Description
TSyntax	syntax

Returns

Type	Description
TSyntax

Type Parameters

Name	Description
TSyntax