API Reference
Class
HtmlDiagnosticReport
Mutable report of diagnostics emitted by OfficeIMO HTML workflows.
Inheritance
- Object
- HtmlDiagnosticReport
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property HtmlCapabilityGalleryResult.Diagnostics
- Method HtmlDiagnosticReport.Clone
- Property HtmlResourceSession.Diagnostics
Accepted by parameters
- Method HtmlActiveMediaFilter.Filter
- Method HtmlActiveMediaFilter.Filter
- Method HtmlResourceSession.Resolve
- Method HtmlResourceSession.ResolveAsync
Constructors
public HtmlDiagnosticReport() #Creates an empty diagnostic report.
Methods
Add 3 overloads
public Void Add(HtmlDiagnostic diagnostic) #Returns:
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, HtmlConversionLossKind lossKind = None) #Returns:
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.Html.HtmlConversionLossKind = None
- Conversion fidelity impact represented by the diagnostic.
public Void Add(String component, String code, String message, HtmlDiagnosticSeverity severity, String source, String detail, HtmlConversionLossKind lossKind, HtmlSemanticSourceLocation sourceLocation, String targetAddress) #Returns:
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.Html.HtmlConversionLossKind
- 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) #Returns:
VoidAdds diagnostics to the report in enumeration order.
Parameters
- diagnostics System.Collections.Generic.IEnumerable{OfficeIMO.Html.HtmlDiagnostic}
- Diagnostics to add.
public HtmlDiagnosticReport Clone() #Returns:
HtmlDiagnosticReportCreates an independent copy of the current diagnostic report.
Returns
A report containing the same immutable diagnostics.
public virtual IEnumerator<HtmlDiagnostic> GetEnumerator() #Returns:
IEnumerator<HtmlDiagnostic>Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public IReadOnlyList<HtmlDiagnostic> Diagnostics { get; } #Diagnostics captured by the report in emission order.
public virtual Int32 Count { get; } #Number of diagnostics currently captured.
public virtual HtmlDiagnostic this[Int32 index] { get; } #Gets a diagnostic by emission index.
Parameters
- arg1 System.Int32
public Boolean HasErrors { get; } #Indicates whether any captured diagnostic has error severity.