# RtfConversionReport

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

Class 

`OfficeIMO.Rtf`

**Namespace**

`OfficeIMO.Rtf`

**Assembly**

`OfficeIMO.Rtf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[RtfConversionReport.cs:7](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Conversion/RtfConversionReport.cs#L7)

**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.

### Returned or exposed by 3

- Property [RtfConversionLossException.Report](/api/rtf/officeimo-rtf-rtfconversionlossexception/#property-report)
- Property [RtfConversionResult<T>.Report](/api/rtf/officeimo-rtf-rtfconversionresult/#property-report)
- Property [RtfDocumentMergeResult.Report](/api/rtf/officeimo-rtf-rtfdocumentmergeresult/#property-report)

### Accepted by parameters 3

- Constructor [RtfConversionLossException.RtfConversionLossException](/api/rtf/officeimo-rtf-rtfconversionlossexception/#constructor-ctor-officeimo-rtf-rtfconversionreport) parameter `report`
- Method [RtfConversionReport.Merge](/api/rtf/officeimo-rtf-rtfconversionreport/#method-merge-officeimo-rtf-rtfconversionreport) parameter `report`
- Constructor [RtfConversionResult<T>.RtfConversionResult](/api/rtf/officeimo-rtf-rtfconversionresult/#constructor-ctor-officeimo-rtf-rtfconversionreport) parameter `report`

Filter members 

Show inherited

## Constructors

`public RtfConversionReport()` [#](#constructor-ctor)

[RtfConversionReport.cs:7](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Conversion/RtfConversionReport.cs#L7)

## 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)` [#](#method-add-officeimo-rtf-rtfconversionseverity-string-string-officeimo-rtf-rtfconversionaction-string-string-int32-string)

[RtfConversionReport.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Conversion/RtfConversionReport.cs#L36)

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**

Returns

`RtfConversionDiagnostic`

`public void Add(RtfConversionDiagnostic diagnostic)` [#](#method-add-officeimo-rtf-rtfconversiondiagnostic)

[RtfConversionReport.cs:43](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Conversion/RtfConversionReport.cs#L43)

Adds an existing conversion diagnostic.

Parameters

**diagnostic OfficeIMO.Rtf.RtfConversionDiagnostic required**

`public void AddReadDiagnostics(IEnumerable<RtfDiagnostic>? diagnostics, string? sourcePath = null)` [#](#method-addreaddiagnostics-collections-generic-ienumerable-officeimo-rtf-diagnostics-rtfdiagnostic-string)

[RtfConversionReport.cs:59](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Conversion/RtfConversionReport.cs#L59)

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()` [#](#method-clear)

[RtfConversionReport.cs:55](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Conversion/RtfConversionReport.cs#L55)

Clears diagnostics from a previous conversion run.

`public void Merge(RtfConversionReport? report)` [#](#method-merge-officeimo-rtf-rtfconversionreport)

[RtfConversionReport.cs:48](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Conversion/RtfConversionReport.cs#L48)

Adds diagnostics from another report.

Parameters

**report OfficeIMO.Rtf.RtfConversionReport? required**

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public void ThrowIfLoss()` [#](#method-throwifloss)

Inherited from OfficeConversionReport

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public IReadOnlyList<RtfConversionDiagnostic> NativeDiagnostics { get; }` [#](#property-nativediagnostics)

[RtfConversionReport.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Conversion/RtfConversionReport.cs#L10)

Snapshot of recorded diagnostics in conversion order.

`public override bool HasLoss { get; }` [#](#property-hasloss)

[RtfConversionReport.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Conversion/RtfConversionReport.cs#L24)

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

## Inherited Properties

`public string Source { get; }` [#](#property-source)

Inherited from OfficeConversionReport

`public string Target { get; }` [#](#property-target)

Inherited from OfficeConversionReport

`public string? OutputPath { get; }` [#](#property-outputpath)

Inherited from OfficeConversionReport

`public long ItemsWritten { get; }` [#](#property-itemswritten)

Inherited from OfficeConversionReport

`public TimeSpan Elapsed { get; }` [#](#property-elapsed)

Inherited from OfficeConversionReport

`public IReadOnlyList<OfficeDiagnostic> Diagnostics { get; }` [#](#property-diagnostics)

Inherited from OfficeConversionReport

<!-- PowerForge markdown artifact sha256:DC3FFFDB00D03664808D63D82A7CEC0E7D7CB259E04FF82D2F36740A428138A5 -->
