Struct SyntaxToken

Implements

IEquatable<SyntaxToken>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: Microsoft.CodeAnalysis

Assembly: Microsoft.CodeAnalysis.dll

Syntax

public readonly struct SyntaxToken : IEquatable<SyntaxToken>

Properties

ContainsAnnotations

Declaration

public bool ContainsAnnotations { get; }

Property Value

Type	Description
bool

ContainsDiagnostics

Declaration

public bool ContainsDiagnostics { get; }

Property Value

Type	Description
bool

ContainsDirectives

Declaration

public bool ContainsDirectives { get; }

Property Value

Type	Description
bool

FullSpan

Declaration

public TextSpan FullSpan { get; }

Property Value

Type	Description
TextSpan

HasLeadingTrivia

Declaration

public bool HasLeadingTrivia { get; }

Property Value

Type	Description
bool

HasStructuredTrivia

Declaration

public bool HasStructuredTrivia { get; }

Property Value

Type	Description
bool

HasTrailingTrivia

Declaration

public bool HasTrailingTrivia { get; }

Property Value

Type	Description
bool

IsMissing

Declaration

public bool IsMissing { get; }

Property Value

Type	Description
bool

Language

Declaration

public string Language { get; }

Property Value

Type	Description
string

LeadingTrivia

Declaration

public SyntaxTriviaList LeadingTrivia { get; }

Property Value

Type	Description
SyntaxTriviaList

Parent

Declaration

public SyntaxNode? Parent { get; }

Property Value

Type	Description
SyntaxNode

RawKind

Declaration

public int RawKind { get; }

Property Value

Type	Description
int

Span

Declaration

public TextSpan Span { get; }

Property Value

Type	Description
TextSpan

SpanStart

Declaration

public int SpanStart { get; }

Property Value

Type	Description
int

SyntaxTree

Declaration

public SyntaxTree? SyntaxTree { get; }

Property Value

Type	Description
SyntaxTree

Text

Declaration

public string Text { get; }

Property Value

Type	Description
string

TrailingTrivia

Declaration

public SyntaxTriviaList TrailingTrivia { get; }

Property Value

Type	Description
SyntaxTriviaList

Value

Declaration

public object? Value { get; }

Property Value

Type	Description
object

ValueText

Declaration

public string ValueText { get; }

Property Value

Type	Description
string

Methods

CopyAnnotationsTo(SyntaxToken)

Declaration

public SyntaxToken CopyAnnotationsTo(SyntaxToken token)

Parameters

Type	Name	Description
SyntaxToken	token

Returns

Type	Description
SyntaxToken

Equals(SyntaxToken)

Declaration

public bool Equals(SyntaxToken other)

Parameters

Type	Name	Description
SyntaxToken	other

Returns

Type	Description
bool

Equals(object?)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

GetAllTrivia()

Declaration

public IEnumerable<SyntaxTrivia> GetAllTrivia()

Returns

Type	Description
IEnumerable<SyntaxTrivia>

GetAnnotations(IEnumerable<string>)

Declaration

public IEnumerable<SyntaxAnnotation> GetAnnotations(IEnumerable<string> annotationKinds)

Parameters

Type	Name	Description
IEnumerable<string>	annotationKinds

Returns

Type	Description
IEnumerable<SyntaxAnnotation>

GetAnnotations(string)

Declaration

public IEnumerable<SyntaxAnnotation> GetAnnotations(string annotationKind)

Parameters

Type	Name	Description
string	annotationKind

Returns

Type	Description
IEnumerable<SyntaxAnnotation>

GetAnnotations(params string[])

Declaration

public IEnumerable<SyntaxAnnotation> GetAnnotations(params string[] annotationKinds)

Parameters

Type	Name	Description
string[]	annotationKinds

Returns

Type	Description
IEnumerable<SyntaxAnnotation>

GetDiagnostics()

Declaration

public IEnumerable<Diagnostic> GetDiagnostics()

Returns

Type	Description
IEnumerable<Diagnostic>

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

GetLocation()

Declaration

public Location GetLocation()

Returns

Type	Description
Location

GetNextToken(bool, bool, bool, bool)

Declaration

public SyntaxToken GetNextToken(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

GetPreviousToken(bool, bool, bool, bool)

Declaration

public SyntaxToken GetPreviousToken(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

HasAnnotation(SyntaxAnnotation?)

Declaration

public bool HasAnnotation(SyntaxAnnotation? annotation)

Parameters

Type	Name	Description
SyntaxAnnotation	annotation

Returns

Type	Description
bool

HasAnnotations(string)

Declaration

public bool HasAnnotations(string annotationKind)

Parameters

Type	Name	Description
string	annotationKind

Returns

Type	Description
bool

HasAnnotations(params string[])

Declaration

public bool HasAnnotations(params string[] annotationKinds)

Parameters

Type	Name	Description
string[]	annotationKinds

Returns

Type	Description
bool

IsEquivalentTo(SyntaxToken)

Declaration

public bool IsEquivalentTo(SyntaxToken token)

Parameters

Type	Name	Description
SyntaxToken	token

Returns

Type	Description
bool

IsIncrementallyIdenticalTo(SyntaxToken)

Declaration

public bool IsIncrementallyIdenticalTo(SyntaxToken token)

Parameters

Type	Name	Description
SyntaxToken	token

Returns

Type	Description
bool

IsPartOfStructuredTrivia()

Declaration

public bool IsPartOfStructuredTrivia()

Returns

Type	Description
bool

ToFullString()

Declaration

public string ToFullString()

Returns

Type	Description
string

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

ValueType.ToString()

WithAdditionalAnnotations(params SyntaxAnnotation[])

Declaration

public SyntaxToken WithAdditionalAnnotations(params SyntaxAnnotation[] annotations)

Parameters

Type	Name	Description
SyntaxAnnotation[]	annotations

Returns

Type	Description
SyntaxToken

WithAdditionalAnnotations(IEnumerable<SyntaxAnnotation>)

Declaration

public SyntaxToken WithAdditionalAnnotations(IEnumerable<SyntaxAnnotation> annotations)

Parameters

Type	Name	Description
IEnumerable<SyntaxAnnotation>	annotations

Returns

Type	Description
SyntaxToken

WithLeadingTrivia(SyntaxTriviaList)

Declaration

public SyntaxToken WithLeadingTrivia(SyntaxTriviaList trivia)

Parameters

Type	Name	Description
SyntaxTriviaList	trivia

Returns

Type	Description
SyntaxToken

WithLeadingTrivia(params SyntaxTrivia[]?)

Declaration

public SyntaxToken WithLeadingTrivia(params SyntaxTrivia[]? trivia)

Parameters

Type	Name	Description
SyntaxTrivia[]	trivia

Returns

Type	Description
SyntaxToken

WithLeadingTrivia(IEnumerable<SyntaxTrivia>?)

Declaration

public SyntaxToken WithLeadingTrivia(IEnumerable<SyntaxTrivia>? trivia)

Parameters

Type	Name	Description
IEnumerable<SyntaxTrivia>	trivia

Returns

Type	Description
SyntaxToken

WithTrailingTrivia(SyntaxTriviaList)

Declaration

public SyntaxToken WithTrailingTrivia(SyntaxTriviaList trivia)

Parameters

Type	Name	Description
SyntaxTriviaList	trivia

Returns

Type	Description
SyntaxToken

WithTrailingTrivia(params SyntaxTrivia[]?)

Declaration

public SyntaxToken WithTrailingTrivia(params SyntaxTrivia[]? trivia)

Parameters

Type	Name	Description
SyntaxTrivia[]	trivia

Returns

Type	Description
SyntaxToken

WithTrailingTrivia(IEnumerable<SyntaxTrivia>?)

Declaration

public SyntaxToken WithTrailingTrivia(IEnumerable<SyntaxTrivia>? trivia)

Parameters

Type	Name	Description
IEnumerable<SyntaxTrivia>	trivia

Returns

Type	Description
SyntaxToken

WithTriviaFrom(SyntaxToken)

Declaration

public SyntaxToken WithTriviaFrom(SyntaxToken token)

Parameters

Type	Name	Description
SyntaxToken	token

Returns

Type	Description
SyntaxToken

WithoutAnnotations(params SyntaxAnnotation[])

Declaration

public SyntaxToken WithoutAnnotations(params SyntaxAnnotation[] annotations)

Parameters

Type	Name	Description
SyntaxAnnotation[]	annotations

Returns

Type	Description
SyntaxToken

WithoutAnnotations(IEnumerable<SyntaxAnnotation>)

Declaration

public SyntaxToken WithoutAnnotations(IEnumerable<SyntaxAnnotation> annotations)

Parameters

Type	Name	Description
IEnumerable<SyntaxAnnotation>	annotations

Returns

Type	Description
SyntaxToken

WithoutAnnotations(string)

Declaration

public SyntaxToken WithoutAnnotations(string annotationKind)

Parameters

Type	Name	Description
string	annotationKind

Returns

Type	Description
SyntaxToken

WriteTo(TextWriter)

Declaration

public void WriteTo(TextWriter writer)

Parameters

Type	Name	Description
TextWriter	writer

Operators

operator ==(SyntaxToken, SyntaxToken)

Declaration

public static bool operator ==(SyntaxToken left, SyntaxToken right)

Parameters

Type	Name	Description
SyntaxToken	left
SyntaxToken	right

Returns

Type	Description
bool

operator !=(SyntaxToken, SyntaxToken)

Declaration

public static bool operator !=(SyntaxToken left, SyntaxToken right)

Parameters

Type	Name	Description
SyntaxToken	left
SyntaxToken	right

Returns

Type	Description
bool

Implements

IEquatable<T>

Extension Methods

SyntaxNodeExtensions.WithoutTrivia(SyntaxToken)