API Reference
WordRtfConverterExtensions
Extension methods for converting between WordDocument and RtfDocument.
Inheritance
- Object
- WordRtfConverterExtensions
Methods
public static Void SaveAsRtf(WordDocument document, String path, RtfWriteOptions options = null, Encoding encoding = null) #VoidSaves a Word document as an RTF file.
Parameters
- arg1 OfficeIMO.Word.WordDocument
- arg2 System.String
- arg3 OfficeIMO.Rtf.RtfWriteOptions = null
- arg4 System.Text.Encoding = null
public static Void SaveAsRtf(WordDocument document, Stream stream, RtfWriteOptions options = null, Encoding encoding = null) #VoidSaves a Word document as RTF to a stream without closing or rewinding the stream.
Parameters
- arg1 OfficeIMO.Word.WordDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.Rtf.RtfWriteOptions = null
- arg4 System.Text.Encoding = null
public static async Task SaveAsRtfAsync(WordDocument document, String path, RtfWriteOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = default) #TaskSaves a Word document as an RTF file asynchronously.
Parameters
- arg1 OfficeIMO.Word.WordDocument
- arg2 System.String
- arg3 OfficeIMO.Rtf.RtfWriteOptions = null
- arg4 System.Text.Encoding = null
- arg5 System.Threading.CancellationToken = default
public static async Task SaveAsRtfAsync(WordDocument document, Stream stream, RtfWriteOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = default) #TaskSaves a Word document as RTF to a stream asynchronously without closing or rewinding the stream.
Parameters
- arg1 OfficeIMO.Word.WordDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.Rtf.RtfWriteOptions = null
- arg4 System.Text.Encoding = null
- arg5 System.Threading.CancellationToken = default
public static String ToRtf(WordDocument document, RtfWriteOptions options = null) #StringSerializes a Word document to RTF text.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Rtf.RtfWriteOptions = null
public static Byte[] ToRtfBytes(WordDocument document, RtfWriteOptions options = null, Encoding encoding = null) #Byte[]Serializes a Word document to encoded RTF bytes.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Rtf.RtfWriteOptions = null
- encoding System.Text.Encoding = null
public static RtfDocument ToRtfDocument(WordDocument document) #RtfDocumentConverts a Word document to the semantic RTF model.
Parameters
- document OfficeIMO.Word.WordDocument
public static RtfConversionResult<RtfDocument> ToRtfDocumentResult(WordDocument document) #RtfConversionResult<RtfDocument>Converts Word to RTF and reports any structure that was flattened or omitted.
Parameters
- document OfficeIMO.Word.WordDocument
public static MemoryStream ToRtfStream(WordDocument document, RtfWriteOptions options = null, Encoding encoding = null) #MemoryStreamSerializes a Word document to an encoded RTF memory stream.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Rtf.RtfWriteOptions = null
- encoding System.Text.Encoding = null
public static WordDocument ToWordDocument(RtfDocument rtfDocument) #WordDocumentCreates a Word document from a semantic RTF document.
Parameters
- rtfDocument OfficeIMO.Rtf.RtfDocument
public static RtfConversionResult<WordDocument> ToWordDocumentResult(RtfDocument document) #RtfConversionResult<WordDocument>Converts RTF to Word and reports any structure that was flattened or omitted.
Parameters
- document OfficeIMO.Rtf.RtfDocument
public static RtfConversionResult<WordDocument> ToWordDocumentResult(RtfReadResult readResult, String sourcePath = null) #RtfConversionResult<WordDocument>Converts a native RTF read result to Word while preserving parser and bridge diagnostics.
Parameters
- readResult OfficeIMO.Rtf.RtfReadResult
- sourcePath System.String = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object