SymbolDisplayFormat Class

Definition

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Package:

Microsoft.CodeAnalysis.Common v4.7.0

Source:

SymbolDisplayFormat.cs

Describes the formatting rules that should be used when displaying symbols.

public ref class SymbolDisplayFormat

public class SymbolDisplayFormat

type SymbolDisplayFormat = class

Public Class SymbolDisplayFormat

Inheritance

Object

SymbolDisplayFormat

Constructors

SymbolDisplayFormat(SymbolDisplayGlobalNamespaceStyle, SymbolDisplayTypeQualificationStyle, SymbolDisplayGenericsOptions, SymbolDisplayMemberOptions, SymbolDisplayDelegateStyle, SymbolDisplayExtensionMethodStyle, SymbolDisplayParameterOptions, SymbolDisplayPropertyStyle, SymbolDisplayLocalOptions, SymbolDisplayKindOptions, SymbolDisplayMiscellaneousOptions)

Constructs a new instance of SymbolDisplayFormat accepting a variety of optional parameters.

Properties

CSharpErrorMessageFormat	Formats a symbol description as in a C# compiler error message.
CSharpShortErrorMessageFormat	Formats a symbol description as in a C# compiler short error message.
DelegateStyle	Determines how delegates are displayed (e.g. name vs full signature).
ExtensionMethodStyle	Determines how extension methods are displayed.
FullyQualifiedFormat	Formats the names of all types and namespaces in a fully qualified style (including the global alias).
GenericsOptions	Determines how generics (on types and methods) should be described (i.e. the level of detail).
GlobalNamespaceStyle	Determines how the global namespace is displayed.
KindOptions	Determines which kind keywords should be included when displaying symbols.
LocalOptions	Determines how local variables are displayed.
MemberOptions	Determines how fields, properties, events, and methods are displayed.
MinimallyQualifiedFormat	Formats a symbol description in a form that suits ToMinimalDisplayString(SemanticModel, Int32, SymbolDisplayFormat).
MiscellaneousOptions	Determines other characteristics of how symbols are displayed.
ParameterOptions	Determines how parameters (of methods, properties/indexers, and delegates) are displayed.
PropertyStyle	Determines how properties are displayed. For example, "Prop" vs "Prop { get; set; }" in C# or "Prop" vs. "ReadOnly Prop" in Visual Basic.
TypeQualificationStyle	Determines how types are qualified (e.g. Nested vs Containing.Nested vs Namespace.Containing.Nested).
VisualBasicErrorMessageFormat	Formats a symbol description as in a Visual Basic compiler error message.
VisualBasicShortErrorMessageFormat	Formats a symbol description as in a Visual Basic compiler short error message.

Methods

AddGenericsOptions(SymbolDisplayGenericsOptions)	Creates a copy of the SymbolDisplayFormat but with an additional set of SymbolDisplayGenericsOptions.
AddKindOptions(SymbolDisplayKindOptions)	Creates a copy of the SymbolDisplayFormat but with an additional set of SymbolDisplayKindOptions.
AddLocalOptions(SymbolDisplayLocalOptions)	Creates a copy of the SymbolDisplayFormat but with an additional set of SymbolDisplayLocalOptions.
AddMemberOptions(SymbolDisplayMemberOptions)	Creates a copy of the SymbolDisplayFormat but with an additional set of SymbolDisplayMemberOptions.
AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions)	Creates a copy of the SymbolDisplayFormat but with an additional set of SymbolDisplayMiscellaneousOptions.
AddParameterOptions(SymbolDisplayParameterOptions)	Creates a copy of the SymbolDisplayFormat but with an additional set of SymbolDisplayParameterOptions.
RemoveGenericsOptions(SymbolDisplayGenericsOptions)	Creates a copy of the SymbolDisplayFormat but with a set of SymbolDisplayGenericsOptions stripped away from the original object.
RemoveKindOptions(SymbolDisplayKindOptions)	Creates a copy of the SymbolDisplayFormat but with a set of SymbolDisplayKindOptions stripped away from the original object.
RemoveLocalOptions(SymbolDisplayLocalOptions)	Creates a copy of the SymbolDisplayFormat but with a set of SymbolDisplayLocalOptions stripped away from the original object.
RemoveMemberOptions(SymbolDisplayMemberOptions)	Creates a copy of the SymbolDisplayFormat but with a set of SymbolDisplayMemberOptions stripped away from the original object.
RemoveMiscellaneousOptions(SymbolDisplayMiscellaneousOptions)	Creates a copy of the SymbolDisplayFormat without the specified SymbolDisplayMiscellaneousOptions.
RemoveParameterOptions(SymbolDisplayParameterOptions)	Creates a copy of the SymbolDisplayFormat but with a set of SymbolDisplayParameterOptions stripped away from the original object.
WithGenericsOptions(SymbolDisplayGenericsOptions)	Creates a copy of the SymbolDisplayFormat but with replaced set of SymbolDisplayGenericsOptions.
WithGlobalNamespaceStyle(SymbolDisplayGlobalNamespaceStyle)	Creates a copy of the SymbolDisplayFormat but with replaced SymbolDisplayGlobalNamespaceStyle.
WithKindOptions(SymbolDisplayKindOptions)	Creates a copy of the SymbolDisplayFormat but with replaced set of SymbolDisplayKindOptions.
WithLocalOptions(SymbolDisplayLocalOptions)	Creates a copy of the SymbolDisplayFormat but with replaced set of SymbolDisplayLocalOptions.
WithMemberOptions(SymbolDisplayMemberOptions)	Creates a copy of the SymbolDisplayFormat but with replaced set of SymbolDisplayMemberOptions.
WithMiscellaneousOptions(SymbolDisplayMiscellaneousOptions)	Creates a copy of the SymbolDisplayFormat but with replaced set of SymbolDisplayMiscellaneousOptions.
WithParameterOptions(SymbolDisplayParameterOptions)	Creates a copy of the SymbolDisplayFormat but with replaced set of SymbolDisplayParameterOptions.