Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 565 stars PSWriteOfficePowerShell module 165 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/

API Reference

Class

WordPdfConverterExtensions

Edit on GitHub
Namespace OfficeIMO.Word.Pdf
Assembly OfficeIMO.Word.Pdf
Source ../../../../_/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.cs:19
Modifiers static

Provides extension methods for converting WordDocument instances to PDF files.

Inheritance

  • Object
  • WordPdfConverterExtensions

Methods

SaveAsPdf 2 overloads
public static PdfSaveResult SaveAsPdf(WordDocument document, String path, WordToPdfOptions options = null, CancellationToken cancellationToken = default) #
../../../../_/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.cs:54
Returns: PdfSaveResult

Saves the specified WordDocument as a PDF at the given path.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
The document to convert.
path System.String requiredposition: 1
The output PDF file path.
options OfficeIMO.Word.Pdf.WordToPdfOptions = null optionalposition: 2
Optional PDF configuration.
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
Cancellation observed during conversion.
public static PdfSaveResult SaveAsPdf(WordDocument document, Stream stream, WordToPdfOptions options = null, CancellationToken cancellationToken = default) #
../../../../_/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.cs:102
Returns: PdfSaveResult

Saves the specified WordDocument as a PDF to the provided stream.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
The document to convert.
stream System.IO.Stream requiredposition: 1
The output stream to receive the PDF data.
options OfficeIMO.Word.Pdf.WordToPdfOptions = null optionalposition: 2
Optional PDF configuration.
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
Cancellation observed during conversion.
SaveAsPdfAsync 2 overloads
public static async Task<PdfSaveResult> SaveAsPdfAsync(WordDocument document, String path, WordToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task<PdfSaveResult>

Saves the specified WordDocument as a PDF at the given path asynchronously.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
The document to convert.
path System.String requiredposition: 1
The output PDF file path.
options OfficeIMO.Word.Pdf.WordToPdfOptions = null optionalposition: 2
Optional PDF configuration.
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
A token to observe while waiting for the task to complete.

Returns

The saved PDF output result with conversion and pipeline diagnostics.

public static async Task<PdfSaveResult> SaveAsPdfAsync(WordDocument document, Stream stream, WordToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task<PdfSaveResult>

Saves the specified WordDocument as a PDF to the provided stream asynchronously.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
The document to convert.
stream System.IO.Stream requiredposition: 1
The output stream to receive the PDF data.
options OfficeIMO.Word.Pdf.WordToPdfOptions = null optionalposition: 2
Optional PDF configuration.
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
A token to observe while waiting for the task to complete.

Returns

The saved PDF output result with conversion and pipeline diagnostics.

SaveAsPdfResult 2 overloads
public static PdfSaveResult SaveAsPdfResult(WordDocument document, String path, WordToPdfOptions options = null, CancellationToken cancellationToken = default) #
../../../../_/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.cs:80
Returns: PdfSaveResult

Attempts to save the specified WordDocument as a PDF file and returns output diagnostics instead of throwing.

Parameters

arg1 OfficeIMO.Word.WordDocument requiredposition: 0
arg2 System.String requiredposition: 1
arg3 OfficeIMO.Word.Pdf.WordToPdfOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static PdfSaveResult SaveAsPdfResult(WordDocument document, Stream stream, WordToPdfOptions options = null, CancellationToken cancellationToken = default) #
../../../../_/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.cs:123
Returns: PdfSaveResult

Attempts to write the specified WordDocument as a PDF to a stream and returns output diagnostics instead of throwing.

Parameters

arg1 OfficeIMO.Word.WordDocument requiredposition: 0
arg2 System.IO.Stream requiredposition: 1
arg3 OfficeIMO.Word.Pdf.WordToPdfOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
SaveAsPdfResultAsync 2 overloads
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(WordDocument document, String path, WordToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task<PdfSaveResult>

Attempts to save the specified WordDocument as a PDF file asynchronously and returns output diagnostics instead of throwing.

Parameters

arg1 OfficeIMO.Word.WordDocument requiredposition: 0
arg2 System.String requiredposition: 1
arg3 OfficeIMO.Word.Pdf.WordToPdfOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(WordDocument document, Stream stream, WordToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task<PdfSaveResult>

Attempts to write the specified WordDocument as a PDF to a stream asynchronously and returns output diagnostics instead of throwing.

Parameters

arg1 OfficeIMO.Word.WordDocument requiredposition: 0
arg2 System.IO.Stream requiredposition: 1
arg3 OfficeIMO.Word.Pdf.WordToPdfOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static Byte[] ToPdfBytes(WordDocument document, WordToPdfOptions options = null, CancellationToken cancellationToken = default) #
../../../../_/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.cs:148
Returns: Byte[]

Converts the specified WordDocument to PDF bytes.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
The document to convert.
options OfficeIMO.Word.Pdf.WordToPdfOptions = null optionalposition: 1
Optional PDF configuration.
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
Cancellation observed during conversion.

Returns

The generated PDF as a byte array.

Examples


byte[] pdf = document.ToPdfBytes();
public static PdfDocument ToPdfDocument(WordDocument document, WordToPdfOptions options = null, CancellationToken cancellationToken = default) #
../../../../_/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.cs:19
Returns: PdfDocument

Converts the specified WordDocument to a first-party OfficeIMO PDF document model.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
The document to convert.
options OfficeIMO.Word.Pdf.WordToPdfOptions = null optionalposition: 1
Optional PDF configuration.
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
Cancellation observed at document-section and element boundaries.

Returns

The generated first-party PDF document model.

public static PdfDocumentConversionResult ToPdfDocumentResult(WordDocument document, WordToPdfOptions options = null, CancellationToken cancellationToken = default) #
../../../../_/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.cs:27
Returns: PdfDocumentConversionResult

Converts the specified WordDocument to a PDF document and returns conversion diagnostics with it.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
options OfficeIMO.Word.Pdf.WordToPdfOptions = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2