Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

WordRtfConverterExtensions

OfficeIMO.Word.Rtf

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

Extension methods for converting between WordDocument and RtfDocument.

Inheritance

  • object
  • WordRtfConverterExtensions

Methods

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

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

Parameters

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

Returns

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

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

Parameters

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

Returns

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

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

Parameters

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

Returns

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

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

Parameters

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

Returns

Task<OfficeConversionReport>
SaveAsWord 4 overloads
public static OfficeConversionReport SaveAsWord(RtfDocument document, string path, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

document OfficeIMO.Rtf.RtfDocument required
path string required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsWord(RtfDocument document, Stream stream, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

document OfficeIMO.Rtf.RtfDocument required
stream System.IO.Stream required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsWord(RtfReadResult readResult, string path, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

readResult OfficeIMO.Rtf.RtfReadResult required
path string required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsWord(RtfReadResult readResult, Stream stream, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

readResult OfficeIMO.Rtf.RtfReadResult required
stream System.IO.Stream required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsWordAsync 4 overloads
public static async Task<OfficeConversionReport> SaveAsWordAsync(RtfDocument document, string path, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

document OfficeIMO.Rtf.RtfDocument required
path string required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsWordAsync(RtfDocument document, Stream stream, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

document OfficeIMO.Rtf.RtfDocument required
stream System.IO.Stream required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsWordAsync(RtfReadResult readResult, string path, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

readResult OfficeIMO.Rtf.RtfReadResult required
path string required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsWordAsync(RtfReadResult readResult, Stream stream, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

readResult OfficeIMO.Rtf.RtfReadResult required
stream System.IO.Stream required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToRtf 2 overloads
public static RtfDocument ToRtf(WordDocument document, WordRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a Word document to the semantic RTF model.

Parameters

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

Returns

RtfDocument
public static RtfDocument ToRtf(WordDocument document, WordRtfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts a Word document to the semantic RTF model and returns the completed conversion report.

Parameters

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

Returns

RtfDocument
public static Task<OfficeConversionResult<RtfDocument>> ToRtfAsync(WordDocument document, WordRtfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a Word document to the semantic RTF model, returning the value and report together.

Parameters

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

Returns

Task<OfficeConversionResult<RtfDocument>>
ToWord 4 overloads
public static WordDocument ToWord(RtfDocument document, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a semantic RTF document to a Word document.

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

WordDocument
public static WordDocument ToWord(RtfDocument document, RtfWordExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts a semantic RTF document to a Word document and returns the completed conversion report.

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

WordDocument
public static WordDocument ToWord(RtfReadResult readResult, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a parsed RTF read result, including its read diagnostics, to a Word document.

Parameters

readResult OfficeIMO.Rtf.RtfReadResult required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

WordDocument
public static WordDocument ToWord(RtfReadResult readResult, RtfWordExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts a parsed RTF read result, including its read diagnostics, to a Word document and returns the completed conversion report.

Parameters

readResult OfficeIMO.Rtf.RtfReadResult required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

WordDocument
ToWordAsync 2 overloads
public static Task<OfficeConversionResult<WordDocument>> ToWordAsync(RtfDocument document, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a semantic RTF document to a Word document, returning the value and report together.

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<WordDocument>>
public static Task<OfficeConversionResult<WordDocument>> ToWordAsync(RtfReadResult readResult, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a parsed RTF read result, including its read diagnostics, to a Word document, returning the value and report together.

Parameters

readResult OfficeIMO.Rtf.RtfReadResult required
options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<WordDocument>>