API Reference
Class
RtfConversionReport
Shared fidelity and policy report used by every RTF conversion adapter.
Inheritance
- Object
- RtfConversionReport
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 RtfConversionLossException.Report
- Property RtfConversionResult.Report
- Property RtfDocumentMergeResult.Report
Accepted by parameters
- Constructor RtfConversionLossException.RtfConversionLossException
- Method RtfConversionReport.Merge
- Constructor RtfConversionResult.RtfConversionResult
Constructors
public RtfConversionReport() #Methods
Add 2 overloads
public RtfConversionDiagnostic Add(RtfConversionSeverity severity, String code, String message, RtfConversionAction action, String sourcePath = null, String feature = null, Int32 count = 1, String detail = null) #Returns:
RtfConversionDiagnosticAdds a conversion diagnostic.
Parameters
- severity OfficeIMO.Rtf.RtfConversionSeverity
- code System.String
- message System.String
- action OfficeIMO.Rtf.RtfConversionAction
- sourcePath System.String = null
- feature System.String = null
- count System.Int32 = 1
- detail System.String = null
public Void Add(RtfConversionDiagnostic diagnostic) #Returns:
VoidAdds an existing conversion diagnostic.
Parameters
- diagnostic OfficeIMO.Rtf.RtfConversionDiagnostic
public Void AddReadDiagnostics(IEnumerable<RtfDiagnostic> diagnostics, String sourcePath = null) #Returns:
VoidMaps parser and binder diagnostics into the shared report.
Parameters
- diagnostics System.Collections.Generic.IEnumerable{OfficeIMO.Rtf.Diagnostics.RtfDiagnostic}
- sourcePath System.String = null
public Void Merge(RtfConversionReport report) #Returns:
VoidAdds diagnostics from another report.
Parameters
- report OfficeIMO.Rtf.RtfConversionReport
public virtual Void RequireNoLoss() #Returns:
VoidThrows when the report contains any fidelity loss or blocked feature.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public IReadOnlyList<RtfConversionDiagnostic> Diagnostics { get; } #Snapshot of recorded diagnostics in conversion order.
public virtual IReadOnlyList<OfficeConversionFidelityDiagnostic> FidelityDiagnostics { get; } #Category-preserving diagnostics for composed conversion routes.
public virtual Boolean HasLoss { get; } #Whether the report contains a flattened, omitted, blocked, or error condition.