Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

AdfConversionDiagnostic

OfficeIMO.Adf

Namespace
OfficeIMO.Adf
Assembly
OfficeIMO.Adf
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

A conversion decision recorded for fidelity review.

Inheritance

  • object
  • AdfConversionDiagnostic

Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Accepted by parameters 1

Constructors

AdfConversionDiagnostic 2 overloads
public AdfConversionDiagnostic(string code, string path, string message, AdfConversionSeverity severity) #

Creates a diagnostic to include in a conversion report.

Parameters

code string required
Non-empty identifier for the conversion decision.
path string required
Location associated with the decision; use $ for the document root.
message string required
Non-empty explanation for a reader of the report.
severity OfficeIMO.Adf.AdfConversionSeverity required
Severity used by the report's fidelity and error checks.
public AdfConversionDiagnostic(string code, string path, string message, AdfConversionSeverity severity, OfficeConversionLossKind lossKind) #

Creates a diagnostic with an explicit fidelity-loss category.

Parameters

code string required
Non-empty identifier for the conversion decision.
path string required
Location associated with the decision; use $ for the document root.
message string required
Non-empty explanation for a reader of the report.
severity OfficeIMO.Adf.AdfConversionSeverity required
Severity used by the report's fidelity and error checks.
lossKind OfficeIMO.OfficeConversionLossKind required
Exact fidelity-loss category.

Properties

public string Code { get; } #

Gets the diagnostic identifier supplied by the converter or caller.

public string Path { get; } #

Gets the location associated with the decision, typically a JSON-style ADF path.

public string Message { get; } #

Gets the human-readable explanation of the conversion decision.

public AdfConversionSeverity Severity { get; } #

Gets the severity used when evaluating fidelity and errors in a report.

public OfficeConversionLossKind LossKind { get; } #

Gets the exact fidelity-loss category represented by this diagnostic.