# WordPdfConverterExtensions

Provides extension methods for converting WordDocument instances to PDF files.

Class 

`OfficeIMO.Word.Pdf`

**Namespace**

`OfficeIMO.Word.Pdf`

**Assembly**

`OfficeIMO.Word.Pdf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[WordPdfConverterExtensions.Conversion.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.Conversion.cs#L10)

**Modifiers**

static

Provides extension methods for converting WordDocument instances to PDF files.

## Inheritance

- object
- WordPdfConverterExtensions

Filter members 

Show inherited

## Methods

SaveAsPdf 2 overloads

`public static OfficeConversionReport SaveAsPdf(WordDocument document, string path, WordPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaspdf-officeimo-word-worddocument-string-officeimo-word-pdf-wordpdfexportoptions-threading-cancellationtoken)

[WordPdfConverterExtensions.Conversion.cs:38](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.Conversion.cs#L38)

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)` [#](#method-saveaspdf-officeimo-word-worddocument-io-stream-officeimo-word-pdf-wordpdfexportoptions-threading-cancellationtoken)

[WordPdfConverterExtensions.Conversion.cs:52](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.Conversion.cs#L52)

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)` [#](#method-saveaspdfasync-officeimo-word-worddocument-string-officeimo-word-pdf-wordpdfexportoptions-threading-cancellationtoken)

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)` [#](#method-saveaspdfasync-officeimo-word-worddocument-io-stream-officeimo-word-pdf-wordpdfexportoptions-threading-cancellationtoken)

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)` [#](#method-topdf-officeimo-word-worddocument-officeimo-word-pdf-wordpdfexportoptions-threading-cancellationtoken)

[WordPdfConverterExtensions.Conversion.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.Conversion.cs#L10)

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)` [#](#method-topdf-officeimo-word-worddocument-officeimo-word-pdf-wordpdfexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[WordPdfConverterExtensions.Conversion.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.Conversion.cs#L15)

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)` [#](#method-topdfasync-officeimo-word-worddocument-officeimo-word-pdf-wordpdfexportoptions-threading-cancellationtoken)

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)` [#](#method-withpdflayoutpagination-officeimo-word-wordfieldupdateoptions)

[WordPdfConverterExtensions.FieldPagination.cs:8](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Pdf/WordPdfConverterExtensions.FieldPagination.cs#L8)

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.

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

<!-- PowerForge markdown artifact sha256:CD2840D6E8D99F9386EE1F02F6AB05DABE5D6B6F348D2B826D3C1D9D39C67250 -->
