WordRtfConverterExtensions
OfficeIMO.Word.Rtf
Extension methods for converting between WordDocument and RtfDocument.
Inheritance
- object
- WordRtfConverterExtensions
Methods
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
- path string
- options OfficeIMO.Word.Rtf.WordRtfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- stream System.IO.Stream
- options OfficeIMO.Word.Rtf.WordRtfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- path string
- options OfficeIMO.Word.Rtf.WordRtfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- stream System.IO.Stream
- options OfficeIMO.Word.Rtf.WordRtfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>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
- path string
- options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- stream System.IO.Stream
- options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- path string
- options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- stream System.IO.Stream
- options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- path string
- options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- stream System.IO.Stream
- options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- path string
- options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- stream System.IO.Stream
- options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>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
- options OfficeIMO.Word.Rtf.WordRtfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
RtfDocumentpublic 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
- options OfficeIMO.Word.Rtf.WordRtfExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
RtfDocumentpublic 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
- options OfficeIMO.Word.Rtf.WordRtfExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<RtfDocument>>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
- options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
WordDocumentpublic 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
- options OfficeIMO.Word.Rtf.RtfWordExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
WordDocumentpublic 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
- options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
WordDocumentpublic 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
- options OfficeIMO.Word.Rtf.RtfWordExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
WordDocumentpublic 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
- options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<WordDocument>>