SymbolDisplay.ToDisplayString(ISymbol, SymbolDisplayFormat) Method

Definition

Namespace:

Microsoft.CodeAnalysis.VisualBasic

Assembly:

Microsoft.CodeAnalysis.VisualBasic.dll

Package:

Microsoft.CodeAnalysis.VisualBasic v4.7.0

Source:

SymbolDisplay.vb

Displays a symbol in the Visual Basic 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 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 Nothing is passed, VisualBasicErrorMessageFormat 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 Visual Basic.