Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 701 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Class

RtfImageConversionExtensions

OfficeIMO.Rtf.Pdf

Edit on GitHub
Namespace
OfficeIMO.Rtf.Pdf
Assembly
OfficeIMO.Rtf.Pdf
Source revision
ac7e6e1bad8a with working tree changes
Source
RtfImageConversionExtensions.cs:13
Modifiers
static

Renders RTF through the existing PDF layout and shared image-export owners.

Inheritance

  • object
  • RtfImageConversionExtensions

Methods

public static OfficeConversionReport SaveAsImages(RtfDocument document, string folderPath, PdfImageExportOptions? imageOptions = null, RtfPdfExportOptions? conversionOptions = null, CancellationToken cancellationToken = default) #
RtfImageConversionExtensions.cs:40

Saves selected pages using shared atomic image files, limits, and loss rejection.

Parameters

document OfficeIMO.Rtf.RtfDocument required
folderPath string required
imageOptions OfficeIMO.Pdf.PdfImageExportOptions? = null optional
conversionOptions OfficeIMO.Rtf.Pdf.RtfPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static async Task<OfficeConversionReport> SaveAsImagesAsync(RtfDocument document, string folderPath, PdfImageExportOptions? imageOptions = null, RtfPdfExportOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Saves selected pages asynchronously while releasing completed image payloads.

Parameters

document OfficeIMO.Rtf.RtfDocument required
folderPath string required
imageOptions OfficeIMO.Pdf.PdfImageExportOptions? = null optional
conversionOptions OfficeIMO.Rtf.Pdf.RtfPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToImages 3 overloads
public static IReadOnlyList<OfficeImageExportResult> ToImages(RtfDocument document, PdfImageExportOptions? imageOptions = null, RtfPdfExportOptions? conversionOptions = null, CancellationToken cancellationToken = default) #
RtfImageConversionExtensions.cs:13

Renders selected pages, retaining RTF conversion and PDF rendering diagnostics.

Parameters

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

Returns

IReadOnlyList<OfficeImageExportResult>
public static IReadOnlyList<OfficeImageExportResult> ToImages(RtfDocument document, OfficeImageExportFormat format, PdfImageExportOptions? imageOptions = null, RtfPdfExportOptions? conversionOptions = null, CancellationToken cancellationToken = default) #
RtfImageConversionExtensions.cs:19

Renders selected pages with an explicit encoding.

Parameters

document OfficeIMO.Rtf.RtfDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
imageOptions OfficeIMO.Pdf.PdfImageExportOptions? = null optional
conversionOptions OfficeIMO.Rtf.Pdf.RtfPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IReadOnlyList<OfficeImageExportResult>
public static void ToImages(RtfDocument document, OfficeImageExportConsumer consumer, PdfImageExportOptions? imageOptions = null, RtfPdfExportOptions? conversionOptions = null, CancellationToken cancellationToken = default) #
RtfImageConversionExtensions.cs:28

Streams selected pages without retaining earlier encoded payloads.

Parameters

document OfficeIMO.Rtf.RtfDocument required
consumer OfficeIMO.Drawing.OfficeImageExportConsumer required
imageOptions OfficeIMO.Pdf.PdfImageExportOptions? = null optional
conversionOptions OfficeIMO.Rtf.Pdf.RtfPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public static Task<IReadOnlyList<OfficeImageExportResult>> ToImagesAsync(RtfDocument document, PdfImageExportOptions? imageOptions = null, RtfPdfExportOptions? conversionOptions = null, CancellationToken cancellationToken = default) #
RtfImageConversionExtensions.cs:34

Renders selected pages asynchronously under the shared deadline and cancellation policy.

Parameters

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

Returns

Task<IReadOnlyList<OfficeImageExportResult>>