Share via

Diagnostic.CustomEditorDiagnosticRepresentation Property

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.RpcContracts.DiagnosticManagement
Assembly:
Microsoft.VisualStudio.RpcContracts.dll
Package:
Microsoft.VisualStudio.RpcContracts v17.12.12

Gets the name of EditorFromatDefiniton to override the default representation of diagnostics in the editor offered by the Diagnostics Service.

public:
 property System::String ^ CustomEditorDiagnosticRepresentation { System::String ^ get(); };
[System.Runtime.Serialization.DataMember(Order=15)]
public string? CustomEditorDiagnosticRepresentation { get; }
[<System.Runtime.Serialization.DataMember(Order=15)>]
member this.CustomEditorDiagnosticRepresentation : string
Public ReadOnly Property CustomEditorDiagnosticRepresentation As String

Property Value

String
Attributes
DataMemberAttribute

Remarks

Diagnostics are usually represented by squiggles in the VS editor. Each DiagnosticSeverity will have a default representation associated to it. However, there are times when clients want to express different types of diagnostics having the same severity in different representations. For example a client would want to denote compile time errors via red squiggles, where as errors from build / configuration via purple squiggles although both have the same severity as Error.

The field is optional. If not provided, default represntations would be used for the corresponding DiagnosticSeverity. The string, if provided, should exactly match the corresponding name of the existing inproc EditorFormatDefiniton used as representation of the diagnositcs.

Applies to