SymbolDisplay.ToDisplayParts Method

Definition

Namespace:

Microsoft.CodeAnalysis.CSharp

Assembly:

Microsoft.CodeAnalysis.CSharp.dll

Package:

Microsoft.CodeAnalysis.CSharp v4.9.2

Overloads

ToDisplayParts(ISymbol, SymbolDisplayFormat)	Convert a symbol to an array of string parts, each of which has a kind. Useful for colorizing the display string.
ToDisplayParts(ITypeSymbol, NullableAnnotation, SymbolDisplayFormat)
ToDisplayParts(ITypeSymbol, NullableFlowState, SymbolDisplayFormat)

ToDisplayParts(ISymbol, SymbolDisplayFormat)

Source:

SymbolDisplay.cs

Convert a symbol to an array of string parts, each of which has a kind. Useful for colorizing the display string.

public static System.Collections.Immutable.ImmutableArray<Microsoft.CodeAnalysis.SymbolDisplayPart> ToDisplayParts (Microsoft.CodeAnalysis.ISymbol symbol, Microsoft.CodeAnalysis.SymbolDisplayFormat? format = default);

static member ToDisplayParts : Microsoft.CodeAnalysis.ISymbol * Microsoft.CodeAnalysis.SymbolDisplayFormat -> System.Collections.Immutable.ImmutableArray<Microsoft.CodeAnalysis.SymbolDisplayPart>

Public Shared Function ToDisplayParts (symbol As ISymbol, Optional format As SymbolDisplayFormat = Nothing) As ImmutableArray(Of SymbolDisplayPart)

Parameters

symbol

ISymbol

The symbol to be displayed.

format

SymbolDisplayFormat

The formatting options to apply. If null is passed, CSharpErrorMessageFormat will be used.

Returns

ImmutableArray<SymbolDisplayPart>

A list of display parts.

Remarks

Parts are not localized until they are converted to strings.

ToDisplayParts(ITypeSymbol, NullableAnnotation, SymbolDisplayFormat)

Source:

SymbolDisplay.cs

public static System.Collections.Immutable.ImmutableArray<Microsoft.CodeAnalysis.SymbolDisplayPart> ToDisplayParts (Microsoft.CodeAnalysis.ITypeSymbol symbol, Microsoft.CodeAnalysis.NullableAnnotation nullableAnnotation, Microsoft.CodeAnalysis.SymbolDisplayFormat? format = default);

static member ToDisplayParts : Microsoft.CodeAnalysis.ITypeSymbol * Microsoft.CodeAnalysis.NullableAnnotation * Microsoft.CodeAnalysis.SymbolDisplayFormat -> System.Collections.Immutable.ImmutableArray<Microsoft.CodeAnalysis.SymbolDisplayPart>

Public Shared Function ToDisplayParts (symbol As ITypeSymbol, nullableAnnotation As NullableAnnotation, Optional format As SymbolDisplayFormat = Nothing) As ImmutableArray(Of SymbolDisplayPart)

Parameters

symbol

ITypeSymbol

nullableAnnotation

NullableAnnotation

format

SymbolDisplayFormat

Returns

ImmutableArray<SymbolDisplayPart>

ToDisplayParts(ITypeSymbol, NullableFlowState, SymbolDisplayFormat)

Source:

SymbolDisplay.cs

public static System.Collections.Immutable.ImmutableArray<Microsoft.CodeAnalysis.SymbolDisplayPart> ToDisplayParts (Microsoft.CodeAnalysis.ITypeSymbol symbol, Microsoft.CodeAnalysis.NullableFlowState nullableFlowState, Microsoft.CodeAnalysis.SymbolDisplayFormat? format = default);

static member ToDisplayParts : Microsoft.CodeAnalysis.ITypeSymbol * Microsoft.CodeAnalysis.NullableFlowState * Microsoft.CodeAnalysis.SymbolDisplayFormat -> System.Collections.Immutable.ImmutableArray<Microsoft.CodeAnalysis.SymbolDisplayPart>

Public Shared Function ToDisplayParts (symbol As ITypeSymbol, nullableFlowState As NullableFlowState, Optional format As SymbolDisplayFormat = Nothing) As ImmutableArray(Of SymbolDisplayPart)

Parameters

symbol

ITypeSymbol

nullableFlowState

NullableFlowState

format

SymbolDisplayFormat

Returns

ImmutableArray<SymbolDisplayPart>