# WordIWorkConverter

Projects Apple Pages sources into editable OfficeIMO Word documents.

Class 

`OfficeIMO.Word.IWork`

**Namespace**

`OfficeIMO.Word.IWork`

**Assembly**

`OfficeIMO.Word.IWork`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[WordIWorkConverter.Api.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.IWork/WordIWorkConverter.Api.cs#L12)

**Modifiers**

static

Projects Apple Pages sources into editable OfficeIMO Word documents.

## Inheritance

- object
- WordIWorkConverter

Filter members 

Show inherited

## Methods

SaveAsWord 2 overloads

`public static OfficeConversionReport SaveAsWord(IWorkSourceDocument package, string path, PagesWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasword-officeimo-iwork-iworksourcedocument-string-officeimo-word-iwork-pageswordexportoptions-threading-cancellationtoken)

[WordIWorkConverter.Api.cs:43](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.IWork/WordIWorkConverter.Api.cs#L43)

Writes the converted output to a path and returns the conversion report.

Parameters

**package OfficeIMO.IWork.IWorkSourceDocument required**

**path string required**

**options OfficeIMO.Word.IWork.PagesWordExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsWord(IWorkSourceDocument package, Stream stream, PagesWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasword-officeimo-iwork-iworksourcedocument-io-stream-officeimo-word-iwork-pageswordexportoptions-threading-cancellationtoken)

[WordIWorkConverter.Api.cs:50](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.IWork/WordIWorkConverter.Api.cs#L50)

Writes the converted output to a caller-owned stream, which stays open and returns the conversion report.

Parameters

**package OfficeIMO.IWork.IWorkSourceDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Word.IWork.PagesWordExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

SaveAsWordAsync 2 overloads

`public static async Task<OfficeConversionReport> SaveAsWordAsync(IWorkSourceDocument package, string path, PagesWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaswordasync-officeimo-iwork-iworksourcedocument-string-officeimo-word-iwork-pageswordexportoptions-threading-cancellationtoken)

Asynchronously writes the converted output to a path and returns the conversion report.

Parameters

**package OfficeIMO.IWork.IWorkSourceDocument required**

**path string required**

**options OfficeIMO.Word.IWork.PagesWordExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsWordAsync(IWorkSourceDocument package, Stream stream, PagesWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaswordasync-officeimo-iwork-iworksourcedocument-io-stream-officeimo-word-iwork-pageswordexportoptions-threading-cancellationtoken)

Asynchronously writes the converted output to a caller-owned stream and returns the conversion report.

Parameters

**package OfficeIMO.IWork.IWorkSourceDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Word.IWork.PagesWordExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

ToWord 2 overloads

`public static WordDocument ToWord(IWorkSourceDocument package, PagesWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toword-officeimo-iwork-iworksourcedocument-officeimo-word-iwork-pageswordexportoptions-threading-cancellationtoken)

[WordIWorkConverter.Api.cs:19](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.IWork/WordIWorkConverter.Api.cs#L19)

Converts a Pages document into the editable Word model.

Parameters

**package OfficeIMO.IWork.IWorkSourceDocument required**

**options OfficeIMO.Word.IWork.PagesWordExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`WordDocument`

`public static WordDocument ToWord(IWorkSourceDocument package, PagesWordExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-toword-officeimo-iwork-iworksourcedocument-officeimo-word-iwork-pageswordexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[WordIWorkConverter.Api.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.IWork/WordIWorkConverter.Api.cs#L24)

Converts a Pages document into the editable Word model and returns the completed conversion report.

Parameters

**package OfficeIMO.IWork.IWorkSourceDocument required**

**options OfficeIMO.Word.IWork.PagesWordExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`WordDocument`

`public static Task<OfficeConversionResult<WordDocument>> ToWordAsync(IWorkSourceDocument package, PagesWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-towordasync-officeimo-iwork-iworksourcedocument-officeimo-word-iwork-pageswordexportoptions-threading-cancellationtoken)

[WordIWorkConverter.Api.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.IWork/WordIWorkConverter.Api.cs#L36)

Converts a Pages document into the editable Word model, returning the value and report together.

Parameters

**package OfficeIMO.IWork.IWorkSourceDocument required**

**options OfficeIMO.Word.IWork.PagesWordExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionResult<WordDocument>>`

`public static PagesToWordResult ToWordResult(IWorkSourceDocument package, IWorkConversionOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-towordresult-officeimo-iwork-iworksourcedocument-officeimo-iwork-iworkconversionoptions-threading-cancellationtoken)

[WordIWorkConverter.Api.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.IWork/WordIWorkConverter.Api.cs#L12)

Converts a Pages document and returns the Word model together with the typed source projection and loss report.

Parameters

**package OfficeIMO.IWork.IWorkSourceDocument required**

**options OfficeIMO.IWork.IWorkConversionOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`PagesToWordResult`

## 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:AAF456F4EDE7959A12AC8F3E889B9FA8DFFE9FAAC4DACDA8E6F4DDA065104E20 -->
