Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

RtfConversionReport

OfficeIMO.Rtf

Namespace
OfficeIMO.Rtf
Assembly
OfficeIMO.Rtf
Source revision
ba882f6b0d07 with working tree changes
Base
OfficeConversionReport
Modifiers
sealed

Shared fidelity and policy report used by every RTF conversion adapter.

Inheritance

  • OfficeConversionReport
  • RtfConversionReport

Usage

Explore 6 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.

Accepted by parameters 3

Constructors

public RtfConversionReport() #

Methods

Add 2 overloads
public RtfConversionDiagnostic Add(RtfConversionSeverity severity, string code, string message, RtfConversionAction action, string? sourcePath = null, string? feature = null, int count = 1, string? detail = null) #

Adds a conversion diagnostic.

Parameters

severity OfficeIMO.Rtf.RtfConversionSeverity required
code string required
message string required
action OfficeIMO.Rtf.RtfConversionAction required
sourcePath string? = null optional
feature string? = null optional
count int = 1 optional
detail string? = null optional
public void Add(RtfConversionDiagnostic diagnostic) #

Adds an existing conversion diagnostic.

Parameters

diagnostic OfficeIMO.Rtf.RtfConversionDiagnostic required
public void AddReadDiagnostics(IEnumerable<RtfDiagnostic>? diagnostics, string? sourcePath = null) #

Maps parser and binder diagnostics into the shared report.

Parameters

diagnostics System.Collections.Generic.IEnumerable<OfficeIMO.Rtf.Diagnostics.RtfDiagnostic>? required
sourcePath string? = null optional
public void Clear() #

Clears diagnostics from a previous conversion run.

public void Merge(RtfConversionReport? report) #

Adds diagnostics from another report.

Parameters

report OfficeIMO.Rtf.RtfConversionReport? required

Properties

public IReadOnlyList<RtfConversionDiagnostic> NativeDiagnostics { get; } #

Snapshot of recorded diagnostics in conversion order.

public override bool HasLoss { get; } #

Whether the report contains a flattened, omitted, blocked, or error condition.