Class Diagnostic

Inheritance

object

Diagnostic

Implements

IEquatable<Diagnostic>

IFormattable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: Microsoft.CodeAnalysis

Assembly: Microsoft.CodeAnalysis.dll

Syntax

public abstract class Diagnostic : IEquatable<Diagnostic?>, IFormattable

Constructors

Diagnostic()

Declaration

protected Diagnostic()

Properties

AdditionalLocations

Declaration

public abstract IReadOnlyList<Location> AdditionalLocations { get; }

Property Value

Type	Description
IReadOnlyList<Location>

DefaultSeverity

Declaration

public virtual DiagnosticSeverity DefaultSeverity { get; }

Property Value

Type	Description
DiagnosticSeverity

Descriptor

Declaration

public abstract DiagnosticDescriptor Descriptor { get; }

Property Value

Type	Description
DiagnosticDescriptor

Id

Declaration

public abstract string Id { get; }

Property Value

Type	Description
string

IsSuppressed

Declaration

public abstract bool IsSuppressed { get; }

Property Value

Type	Description
bool

IsWarningAsError

Declaration

public bool IsWarningAsError { get; }

Property Value

Type	Description
bool

Location

Declaration

public abstract Location Location { get; }

Property Value

Type	Description
Location

Properties

Declaration

public virtual ImmutableDictionary<string, string?> Properties { get; }

Property Value

Type	Description
ImmutableDictionary<string, string>

Severity

Declaration

public abstract DiagnosticSeverity Severity { get; }

Property Value

Type	Description
DiagnosticSeverity

WarningLevel

Declaration

public abstract int WarningLevel { get; }

Property Value

Type	Description
int

Methods

Create(DiagnosticDescriptor, Location?, DiagnosticSeverity, IEnumerable<Location>?, ImmutableDictionary<string, string?>?, params object?[]?)

Declaration

public static Diagnostic Create(DiagnosticDescriptor descriptor, Location? location, DiagnosticSeverity effectiveSeverity, IEnumerable<Location>? additionalLocations, ImmutableDictionary<string, string?>? properties, params object?[]? messageArgs)

Parameters

Type	Name	Description
DiagnosticDescriptor	descriptor
Location	location
DiagnosticSeverity	effectiveSeverity
IEnumerable<Location>	additionalLocations
ImmutableDictionary<string, string>	properties
object[]	messageArgs

Returns

Type	Description
Diagnostic

Create(DiagnosticDescriptor, Location?, IEnumerable<Location>?, ImmutableDictionary<string, string?>?, params object?[]?)

Declaration

public static Diagnostic Create(DiagnosticDescriptor descriptor, Location? location, IEnumerable<Location>? additionalLocations, ImmutableDictionary<string, string?>? properties, params object?[]? messageArgs)

Parameters

Type	Name	Description
DiagnosticDescriptor	descriptor
Location	location
IEnumerable<Location>	additionalLocations
ImmutableDictionary<string, string>	properties
object[]	messageArgs

Returns

Type	Description
Diagnostic

Create(DiagnosticDescriptor, Location?, IEnumerable<Location>?, params object?[]?)

Declaration

public static Diagnostic Create(DiagnosticDescriptor descriptor, Location? location, IEnumerable<Location>? additionalLocations, params object?[]? messageArgs)

Parameters

Type	Name	Description
DiagnosticDescriptor	descriptor
Location	location
IEnumerable<Location>	additionalLocations
object[]	messageArgs

Returns

Type	Description
Diagnostic

Create(DiagnosticDescriptor, Location?, ImmutableDictionary<string, string?>?, params object?[]?)

Declaration

public static Diagnostic Create(DiagnosticDescriptor descriptor, Location? location, ImmutableDictionary<string, string?>? properties, params object?[]? messageArgs)

Parameters

Type	Name	Description
DiagnosticDescriptor	descriptor
Location	location
ImmutableDictionary<string, string>	properties
object[]	messageArgs

Returns

Type	Description
Diagnostic

Create(DiagnosticDescriptor, Location?, params object?[]?)

Declaration

public static Diagnostic Create(DiagnosticDescriptor descriptor, Location? location, params object?[]? messageArgs)

Parameters

Type	Name	Description
DiagnosticDescriptor	descriptor
Location	location
object[]	messageArgs

Returns

Type	Description
Diagnostic

Create(string, string, LocalizableString, DiagnosticSeverity, DiagnosticSeverity, bool, int, LocalizableString?, LocalizableString?, string?, Location?, IEnumerable<Location>?, IEnumerable<string>?, ImmutableDictionary<string, string?>?)

Declaration

public static Diagnostic Create(string id, string category, LocalizableString message, DiagnosticSeverity severity, DiagnosticSeverity defaultSeverity, bool isEnabledByDefault, int warningLevel, LocalizableString? title = null, LocalizableString? description = null, string? helpLink = null, Location? location = null, IEnumerable<Location>? additionalLocations = null, IEnumerable<string>? customTags = null, ImmutableDictionary<string, string?>? properties = null)

Parameters

Type	Name	Description
string	id
string	category
LocalizableString	message
DiagnosticSeverity	severity
DiagnosticSeverity	defaultSeverity
bool	isEnabledByDefault
int	warningLevel
LocalizableString	title
LocalizableString	description
string	helpLink
Location	location
IEnumerable<Location>	additionalLocations
IEnumerable<string>	customTags
ImmutableDictionary<string, string>	properties

Returns

Type	Description
Diagnostic

Create(string, string, LocalizableString, DiagnosticSeverity, DiagnosticSeverity, bool, int, bool, LocalizableString?, LocalizableString?, string?, Location?, IEnumerable<Location>?, IEnumerable<string>?, ImmutableDictionary<string, string?>?)

Declaration

public static Diagnostic Create(string id, string category, LocalizableString message, DiagnosticSeverity severity, DiagnosticSeverity defaultSeverity, bool isEnabledByDefault, int warningLevel, bool isSuppressed, LocalizableString? title = null, LocalizableString? description = null, string? helpLink = null, Location? location = null, IEnumerable<Location>? additionalLocations = null, IEnumerable<string>? customTags = null, ImmutableDictionary<string, string?>? properties = null)

Parameters

Type	Name	Description
string	id
string	category
LocalizableString	message
DiagnosticSeverity	severity
DiagnosticSeverity	defaultSeverity
bool	isEnabledByDefault
int	warningLevel
bool	isSuppressed
LocalizableString	title
LocalizableString	description
string	helpLink
Location	location
IEnumerable<Location>	additionalLocations
IEnumerable<string>	customTags
ImmutableDictionary<string, string>	properties

Returns

Type	Description
Diagnostic

Equals(Diagnostic?)

Declaration

public abstract bool Equals(Diagnostic? obj)

Parameters

Type	Name	Description
Diagnostic	obj

Returns

Type	Description
bool

Equals(object?)

Declaration

public override sealed bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

Declaration

public override abstract int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

GetMessage(IFormatProvider?)

Declaration

public abstract string GetMessage(IFormatProvider? formatProvider = null)

Parameters

Type	Name	Description
IFormatProvider	formatProvider

Returns

Type	Description
string

GetSuppressionInfo(Compilation)

Declaration

public SuppressionInfo? GetSuppressionInfo(Compilation compilation)

Parameters

Type	Name	Description
Compilation	compilation

Returns

Type	Description
SuppressionInfo

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Implements

IEquatable<T>

IFormattable