API Reference
HtmlDiagnosticReport
Mutable report of diagnostics emitted by OfficeIMO HTML workflows.
Inheritance
- Object
- HtmlDiagnosticReport
Usage
Explore 7 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 4
- Property HtmlCapabilityGalleryResult.Diagnostics
- Method HtmlDiagnosticReport.Clone
- Method HtmlDiagnosticReport.Snapshot
- Property HtmlResourceSession.Diagnostics
Accepted by parameters 3
- Method HtmlActiveMediaFilter.Filter
- Method HtmlResourceSession.Resolve
- Method HtmlResourceSession.ResolveAsync
Constructors
Methods
public Void Add(HtmlDiagnostic diagnostic) #VoidAdds an existing diagnostic instance to the report.
Parameters
- diagnostic OfficeIMO.Html.HtmlDiagnostic
- Diagnostic to add.
public Void Add(String component, String code, String message, HtmlDiagnosticSeverity severity = Warning, String? source = null, String? detail = null, OfficeConversionLossKind lossKind = None) #VoidAdds a diagnostic to the report.
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 = 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.
- lossKind OfficeIMO.OfficeConversionLossKind = None
- Conversion fidelity impact represented by the diagnostic.
public Void Add(String component, String code, String message, HtmlDiagnosticSeverity severity, String? source, String? detail, OfficeConversionLossKind lossKind, HtmlSemanticSourceLocation? sourceLocation, String? targetAddress) #VoidAdds a 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 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.
public Void AddRange(IEnumerable<HtmlDiagnostic> diagnostics) #VoidAdds diagnostics to the report in enumeration order.
Parameters
- diagnostics System.Collections.Generic.IEnumerable<OfficeIMO.Html.HtmlDiagnostic>
- Diagnostics to add.
public HtmlDiagnosticReport Clone() #HtmlDiagnosticReportCreates an independent copy of the current diagnostic report.
Returns
A report containing the same immutable diagnostics.
public IEnumerator<HtmlDiagnostic> GetEnumerator() #IEnumerator<HtmlDiagnostic>Returns an enumerator that iterates through the collection.
Returns
An enumerator that can be used to iterate through the collection.
public HtmlDiagnosticReport Snapshot() #HtmlDiagnosticReportCreates an independent, read-only snapshot of the current diagnostics.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public IReadOnlyList<HtmlDiagnostic> Diagnostics { get; } #Diagnostics captured by the report in emission order.
public Boolean IsReadOnly { get; } #True when this report is a frozen result snapshot and can no longer be modified.
public HtmlDiagnostic this[Int32 index] { get; } #Gets a diagnostic by emission index.
Parameters
- index System.Int32
public Boolean HasErrors { get; } #Indicates whether any captured diagnostic has error severity.