SymbolDisplay.ToDisplayString Method

Definition

Namespace:

Microsoft.CodeAnalysis.CSharp

Assembly:

Microsoft.CodeAnalysis.CSharp.dll

Package:

Microsoft.CodeAnalysis.CSharp v4.7.0

Overloads

ToDisplayString(ISymbol, SymbolDisplayFormat)	Displays a symbol in the C# style, based on a SymbolDisplayFormat.
ToDisplayString(ITypeSymbol, NullableAnnotation, SymbolDisplayFormat)
ToDisplayString(ITypeSymbol, NullableFlowState, SymbolDisplayFormat)

ToDisplayString(ISymbol, SymbolDisplayFormat)

Source:

SymbolDisplay.cs

Displays a symbol in the C# style, based on a SymbolDisplayFormat.

public static string ToDisplayString (Microsoft.CodeAnalysis.ISymbol symbol, Microsoft.CodeAnalysis.SymbolDisplayFormat? format = default);

static member ToDisplayString : Microsoft.CodeAnalysis.ISymbol * Microsoft.CodeAnalysis.SymbolDisplayFormat -> string

Public Shared Function ToDisplayString (symbol As ISymbol, Optional format As SymbolDisplayFormat = Nothing) As String

Parameters

symbol

ISymbol

The symbol to be displayed.

format

SymbolDisplayFormat

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

Returns

String

A formatted string that can be displayed to the user.

Remarks

The return value is not expected to be syntactically valid C#.

ToDisplayString(ITypeSymbol, NullableAnnotation, SymbolDisplayFormat)

Source:

SymbolDisplay.cs

public static string ToDisplayString (Microsoft.CodeAnalysis.ITypeSymbol symbol, Microsoft.CodeAnalysis.NullableAnnotation nullableAnnotation, Microsoft.CodeAnalysis.SymbolDisplayFormat? format = default);

static member ToDisplayString : Microsoft.CodeAnalysis.ITypeSymbol * Microsoft.CodeAnalysis.NullableAnnotation * Microsoft.CodeAnalysis.SymbolDisplayFormat -> string

Public Shared Function ToDisplayString (symbol As ITypeSymbol, nullableAnnotation As NullableAnnotation, Optional format As SymbolDisplayFormat = Nothing) As String

Parameters

symbol

ITypeSymbol

nullableAnnotation

NullableAnnotation

format

SymbolDisplayFormat

Returns

String

ToDisplayString(ITypeSymbol, NullableFlowState, SymbolDisplayFormat)

Source:

SymbolDisplay.cs

public static string ToDisplayString (Microsoft.CodeAnalysis.ITypeSymbol symbol, Microsoft.CodeAnalysis.NullableFlowState nullableFlowState, Microsoft.CodeAnalysis.SymbolDisplayFormat? format = default);

static member ToDisplayString : Microsoft.CodeAnalysis.ITypeSymbol * Microsoft.CodeAnalysis.NullableFlowState * Microsoft.CodeAnalysis.SymbolDisplayFormat -> string

Public Shared Function ToDisplayString (symbol As ITypeSymbol, nullableFlowState As NullableFlowState, Optional format As SymbolDisplayFormat = Nothing) As String

Parameters

symbol

ITypeSymbol

nullableFlowState

NullableFlowState

format

SymbolDisplayFormat

Returns

String