Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

RtfPdfConverterExtensions

OfficeIMO.Rtf.Pdf

Namespace
OfficeIMO.Rtf.Pdf
Assembly
OfficeIMO.Rtf.Pdf
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

Converts parsed RtfDocument models to PDF.

Inheritance

  • object
  • RtfPdfConverterExtensions

Methods

SaveAsPdf 2 overloads
public static OfficeConversionReport SaveAsPdf(RtfDocument document, string path, RtfPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes a PDF file and returns the complete conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
path string required
options OfficeIMO.Rtf.Pdf.RtfPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsPdf(RtfDocument document, Stream stream, RtfPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes PDF to a caller-owned stream and returns the complete conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
stream System.IO.Stream required
options OfficeIMO.Rtf.Pdf.RtfPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsPdfAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsPdfAsync(RtfDocument document, string path, RtfPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes a PDF file and returns the complete conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
path string required
options OfficeIMO.Rtf.Pdf.RtfPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsPdfAsync(RtfDocument document, Stream stream, RtfPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes PDF to a caller-owned stream and returns its conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
stream System.IO.Stream required
options OfficeIMO.Rtf.Pdf.RtfPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
SaveAsRtf 4 overloads
public static OfficeConversionReport SaveAsRtf(PdfDocument document, string path, PdfRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes reconstructed RTF and returns its completed conversion report.

Parameters

document OfficeIMO.Pdf.PdfDocument required
path string required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsRtf(PdfDocument document, Stream stream, PdfRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes reconstructed RTF and returns its completed conversion report.

Parameters

document OfficeIMO.Pdf.PdfDocument required
stream System.IO.Stream required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsRtf(PdfDocumentReadResult document, string path, PdfRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes reconstructed RTF and returns its completed conversion report.

Parameters

document OfficeIMO.Pdf.PdfDocumentReadResult required
path string required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsRtf(PdfDocumentReadResult document, Stream stream, PdfRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes reconstructed RTF and returns its completed conversion report.

Parameters

document OfficeIMO.Pdf.PdfDocumentReadResult required
stream System.IO.Stream required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsRtfAsync 4 overloads
public static async Task<OfficeConversionReport> SaveAsRtfAsync(PdfDocument document, string path, PdfRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes reconstructed RTF and returns its completed conversion report.

Parameters

document OfficeIMO.Pdf.PdfDocument required
path string required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsRtfAsync(PdfDocument document, Stream stream, PdfRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes reconstructed RTF and returns its completed conversion report.

Parameters

document OfficeIMO.Pdf.PdfDocument required
stream System.IO.Stream required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsRtfAsync(PdfDocumentReadResult document, string path, PdfRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes reconstructed RTF and returns its completed conversion report.

Parameters

document OfficeIMO.Pdf.PdfDocumentReadResult required
path string required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsRtfAsync(PdfDocumentReadResult document, Stream stream, PdfRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes reconstructed RTF and returns its completed conversion report.

Parameters

document OfficeIMO.Pdf.PdfDocumentReadResult required
stream System.IO.Stream required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToPdf 2 overloads
public static PdfDocument ToPdf(RtfDocument document, RtfPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the source document to a PDF model.

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Rtf.Pdf.RtfPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

PdfDocument
public static PdfDocument ToPdf(RtfDocument document, RtfPdfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts the source document and returns its completed conversion findings.

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Rtf.Pdf.RtfPdfExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

PdfDocument
public static Task<OfficeConversionResult<PdfDocument>> ToPdfAsync(RtfDocument document, RtfPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the source document, returning the model and report together.

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Rtf.Pdf.RtfPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<PdfDocument>>
ToRtf 4 overloads
public static RtfDocument ToRtf(PdfDocument document, PdfRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Reconstructs editable RTF from the supported PDF semantics.

Parameters

document OfficeIMO.Pdf.PdfDocument required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

RtfDocument
public static RtfDocument ToRtf(PdfDocument document, PdfRtfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Reconstructs RTF and retains completed semantic reconstruction diagnostics.

Parameters

document OfficeIMO.Pdf.PdfDocument required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

RtfDocument
public static RtfDocument ToRtf(PdfDocumentReadResult document, PdfRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Reconstructs editable RTF from the supported PDF semantics.

Parameters

document OfficeIMO.Pdf.PdfDocumentReadResult required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

RtfDocument
public static RtfDocument ToRtf(PdfDocumentReadResult document, PdfRtfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Reconstructs RTF and retains completed semantic reconstruction diagnostics.

Parameters

document OfficeIMO.Pdf.PdfDocumentReadResult required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

RtfDocument
ToRtfAsync 2 overloads
public static Task<OfficeConversionResult<RtfDocument>> ToRtfAsync(PdfDocument document, PdfRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Reconstructs RTF asynchronously and returns the document with its report.

Parameters

document OfficeIMO.Pdf.PdfDocument required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<RtfDocument>>
public static Task<OfficeConversionResult<RtfDocument>> ToRtfAsync(PdfDocumentReadResult document, PdfRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Reconstructs RTF asynchronously and returns the document with its report.

Parameters

document OfficeIMO.Pdf.PdfDocumentReadResult required
options OfficeIMO.Rtf.Pdf.PdfRtfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<RtfDocument>>