API Reference
HtmlDiagnostic
Shared diagnostic record for OfficeIMO HTML ingestion, conversion, and artifact workflows.
Inheritance
- Object
- HtmlDiagnostic
Usage
Explore 22 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 15
- Property HtmlCapabilityGalleryArtifactEvidence.Diagnostics
- Property HtmlConversionDocument.Diagnostics
- Property HtmlConversionException.Diagnostics
- Property HtmlConversionPreflight.Diagnostics
- Property HtmlConversionReport.Diagnostics
- Method HtmlDiagnostic.WithProvenance
- Method HtmlDiagnosticReport.GetEnumerator
- Property HtmlDiagnosticReport.Diagnostics
- Property HtmlDiagnosticReport.Item
- Property HtmlEditableLayoutProjection.Diagnostics
- Property HtmlRenderArchiveManifest.Diagnostics
- Property HtmlRenderDocument.Diagnostics
- Property HtmlRenderResult.Diagnostics
- Property HtmlRenderResult.LossDiagnostics
- Property HtmlResourceManifest.Diagnostics
Accepted by parameters 7
- Constructor HtmlCapabilityGalleryArtifactEvidence.HtmlCapabilityGalleryArtifactEvidence
- Constructor HtmlCapabilityGalleryResult.HtmlCapabilityGalleryResult
- Constructor HtmlConversionException.HtmlConversionException
- Method HtmlDiagnosticReport.Add
- Method HtmlDiagnosticReport.AddRange
- Method HtmlRenderResult.WithAdditionalDiagnostics
- Constructor HtmlTextConversionResult.HtmlTextConversionResult
Constructors
public HtmlDiagnostic(String component, String code, String message, HtmlDiagnosticSeverity severity = Warning, String? source = null, String? detail = null, OfficeConversionLossKind lossKind = None) #Creates a shared HTML diagnostic.
Parameters
- component System.String
- Component that emitted the diagnostic, such as OfficeIMO.Word.Html.
- code System.String
- Stable diagnostic code.
- message System.String
- Human-readable diagnostic message.
- severity OfficeIMO.Html.HtmlDiagnosticSeverity = Warning
- Diagnostic severity.
- source System.String? = null
- Optional HTML, resource, or artifact source associated with the diagnostic.
- detail System.String? = null
- Optional low-level detail, such as an exception type, status text, or limit data.
- lossKind OfficeIMO.OfficeConversionLossKind = None
- Conversion fidelity impact represented by the diagnostic.
public HtmlDiagnostic(String component, String code, String message, HtmlDiagnosticSeverity severity, String? source, String? detail, OfficeConversionLossKind lossKind, HtmlSemanticSourceLocation? sourceLocation, String? targetAddress) #Creates a shared diagnostic with typed source-to-target provenance.
Parameters
- component System.String
- Component that emitted the diagnostic.
- code System.String
- Stable diagnostic code.
- message System.String
- Human-readable diagnostic message.
- severity OfficeIMO.Html.HtmlDiagnosticSeverity
- Diagnostic severity.
- source System.String?
- Optional HTML, resource, or artifact source.
- detail System.String?
- Optional low-level detail.
- lossKind OfficeIMO.OfficeConversionLossKind
- Conversion fidelity impact.
- sourceLocation OfficeIMO.Html.HtmlSemanticSourceLocation?
- Optional typed HTML source location.
- targetAddress System.String?
- Optional target artifact address.
Methods
public override String ToString() #StringReturns a string that represents the current object.
Returns
A string that represents the current object.
public HtmlDiagnostic WithProvenance(HtmlSemanticSourceLocation? sourceLocation, String targetAddress) #HtmlDiagnosticCreates an equivalent diagnostic with a more precise source and target address.
Parameters
- sourceLocation OfficeIMO.Html.HtmlSemanticSourceLocation?
- targetAddress System.String
Inherited Methods
Properties
public String? Source { get; } #Optional HTML, resource, or artifact source associated with the diagnostic.
public String? Detail { get; } #Optional low-level detail, such as an exception type, status text, or limit data.
public OfficeConversionLossKind LossKind { get; } #Describes whether this diagnostic represents approximation, omission, or complete conversion failure.
public HtmlDiagnosticProvenance Provenance { get; } #Stable source-to-target provenance. This is always present, with document/component fallbacks.