API Reference
Class
AdfConversionDiagnostic
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
- Property AdfConversionReport.Diagnostics
Accepted by parameters 1
- Constructor AdfConversionReport.AdfConversionReport
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 System.String
- Non-empty identifier for the conversion decision.
- path System.String
- Location associated with the decision; use $ for the document root.
- message System.String
- Non-empty explanation for a reader of the report.
- severity OfficeIMO.Adf.AdfConversionSeverity
- 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 System.String
- Non-empty identifier for the conversion decision.
- path System.String
- Location associated with the decision; use $ for the document root.
- message System.String
- Non-empty explanation for a reader of the report.
- severity OfficeIMO.Adf.AdfConversionSeverity
- Severity used by the report's fidelity and error checks.
- lossKind OfficeIMO.OfficeConversionLossKind
- Exact fidelity-loss category.
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
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.