Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

WordIWorkConverter

OfficeIMO.Word.IWork

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

Projects Apple Pages sources into editable OfficeIMO Word documents.

Inheritance

  • object
  • WordIWorkConverter

Methods

SaveAsWord 2 overloads
public static OfficeConversionReport SaveAsWord(IWorkSourceDocument package, string path, PagesWordExportOptions? options = null, CancellationToken cancellationToken = default) #

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) #

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) #

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) #

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) #

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) #

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) #

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) #

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