Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

WordPdfConverterExtensions

OfficeIMO.Word.Pdf

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

Provides extension methods for converting WordDocument instances to PDF files.

Inheritance

  • object
  • WordPdfConverterExtensions

Methods

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

Writes a PDF file and returns the complete conversion report.

Parameters

document OfficeIMO.Word.WordDocument required
path string required
options OfficeIMO.Word.Pdf.WordPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

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

Parameters

document OfficeIMO.Word.WordDocument required
stream System.IO.Stream required
options OfficeIMO.Word.Pdf.WordPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

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

Parameters

document OfficeIMO.Word.WordDocument required
path string required
options OfficeIMO.Word.Pdf.WordPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

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

Parameters

document OfficeIMO.Word.WordDocument required
stream System.IO.Stream required
options OfficeIMO.Word.Pdf.WordPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Converts the source document to a PDF model.

Parameters

document OfficeIMO.Word.WordDocument required
options OfficeIMO.Word.Pdf.WordPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Converts the source document and returns its completed conversion findings.

Parameters

document OfficeIMO.Word.WordDocument required
options OfficeIMO.Word.Pdf.WordPdfExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

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

Parameters

document OfficeIMO.Word.WordDocument required
options OfficeIMO.Word.Pdf.WordPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<PdfDocument>>
public static WordFieldUpdateOptions WithPdfLayoutPagination(WordFieldUpdateOptions options) #

Returns independent field-update options using the native PDF layout for bookmark and page-count fields.

Parameters

options OfficeIMO.Word.WordFieldUpdateOptions required
Field refresh settings to copy; the caller's instance is unchanged.

Returns

WordFieldUpdateOptions Options that paginate a private document copy after any requested table-of-contents regeneration.