SymbolDisplay.ToDisplayParts(ISymbol, SymbolDisplayFormat) Method

Definition

Namespace:

Microsoft.CodeAnalysis.VisualBasic

Assembly:

Microsoft.CodeAnalysis.VisualBasic.dll

Package:

Microsoft.CodeAnalysis.VisualBasic v4.7.0

Source:

SymbolDisplay.vb

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 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 Nothing Is passed, VisualBasicErrorMessageFormat will be used.

Returns

ImmutableArray<SymbolDisplayPart>

A list of display parts.

Remarks

Parts are not localized until they are converted to strings.