API Reference
Class
WordHtmlConverterExtensions
Extension methods enabling HTML conversions for WordDocument instances.
Inheritance
- Object
- WordHtmlConverterExtensions
Methods
public static Void AddHtml(WordTableCell cell, HtmlConversionDocument htmlDocument, HtmlToWordOptions options = null) #Returns:
VoidAppends HTML content directly to a Word table cell.
Parameters
- cell OfficeIMO.Word.WordTableCell
- Table cell to modify.
- htmlDocument OfficeIMO.Html.HtmlConversionDocument
- Parsed HTML source to insert.
- options OfficeIMO.Word.Html.HtmlToWordOptions = null
- Optional conversion options.
public static async Task AddHtmlAsync(WordTableCell cell, HtmlConversionDocument htmlDocument, HtmlToWordOptions options = null, CancellationToken cancellationToken = default) #Returns:
TaskAsynchronously appends HTML content directly to a Word table cell.
Parameters
- cell OfficeIMO.Word.WordTableCell
- Table cell to modify.
- htmlDocument OfficeIMO.Html.HtmlConversionDocument
- Parsed HTML source to insert.
- options OfficeIMO.Word.Html.HtmlToWordOptions = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor for cancellation requests.
public static Void AddHtmlToBody(WordDocument doc, HtmlConversionDocument htmlDocument, HtmlToWordOptions options = null) #Returns:
VoidAppends HTML content to the document's body.
Parameters
- doc OfficeIMO.Word.WordDocument
- Document to modify.
- htmlDocument OfficeIMO.Html.HtmlConversionDocument
- Parsed HTML source to insert.
- options OfficeIMO.Word.Html.HtmlToWordOptions = null
- Optional conversion options.
public static async Task AddHtmlToBodyAsync(WordDocument doc, HtmlConversionDocument htmlDocument, HtmlToWordOptions options = null, CancellationToken cancellationToken = default) #Returns:
TaskAsynchronously appends HTML content to the document's body.
Parameters
- doc OfficeIMO.Word.WordDocument
- Document to modify.
- htmlDocument OfficeIMO.Html.HtmlConversionDocument
- Parsed HTML source to insert.
- options OfficeIMO.Word.Html.HtmlToWordOptions = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor for cancellation requests.
SaveAsHtml 2 overloads
public static Void SaveAsHtml(WordDocument document, String path, WordToHtmlOptions options = null) #Returns:
VoidSaves the document as an HTML file at the specified path.
Parameters
- document OfficeIMO.Word.WordDocument
- Document to convert.
- path System.String
- Destination file path.
- options OfficeIMO.Word.Html.WordToHtmlOptions = null
- Optional conversion options.
public static Void SaveAsHtml(WordDocument document, Stream stream, WordToHtmlOptions options = null) #Returns:
VoidSaves the document as HTML to the provided stream.
Parameters
- document OfficeIMO.Word.WordDocument
- Document to convert.
- stream System.IO.Stream
- Target stream.
- options OfficeIMO.Word.Html.WordToHtmlOptions = null
- Optional conversion options.
SaveAsHtmlAsync 2 overloads
public static async Task SaveAsHtmlAsync(WordDocument document, String path, WordToHtmlOptions options = null, CancellationToken cancellationToken = default) #Returns:
TaskAsynchronously saves the document as an HTML file at the specified path.
Parameters
- document OfficeIMO.Word.WordDocument
- Document to convert.
- path System.String
- Destination file path.
- options OfficeIMO.Word.Html.WordToHtmlOptions = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor for cancellation requests.
public static async Task SaveAsHtmlAsync(WordDocument document, Stream stream, WordToHtmlOptions options = null, CancellationToken cancellationToken = default) #Returns:
TaskAsynchronously saves the document as HTML to the provided stream.
Parameters
- document OfficeIMO.Word.WordDocument
- Document to convert.
- stream System.IO.Stream
- Target stream.
- options OfficeIMO.Word.Html.WordToHtmlOptions = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor for cancellation requests.
public static String ToHtml(WordDocument document, WordToHtmlOptions options = null) #Returns:
StringConverts the document to an HTML string.
Parameters
- document OfficeIMO.Word.WordDocument
- Document to convert.
- options OfficeIMO.Word.Html.WordToHtmlOptions = null
- Optional conversion options.
Returns
HTML representation of the document.
public static HtmlTextConversionResult ToHtmlResult(WordDocument document, WordToHtmlOptions options = null) #Returns:
HtmlTextConversionResultConverts the document to HTML with the shared structured result contract.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Word.Html.WordToHtmlOptions = null
public static WordDocument ToWordDocument(HtmlConversionDocument document, HtmlToWordOptions options = null) #Returns:
WordDocumentCreates a new document from a shared OfficeIMO HTML conversion document.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- Shared HTML conversion document.
- options OfficeIMO.Word.Html.HtmlToWordOptions = null
- Optional conversion options.
Returns
A new WordDocument instance.
public static async Task<WordDocument> ToWordDocumentAsync(HtmlConversionDocument document, HtmlToWordOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<WordDocument>Asynchronously creates a new document from a shared OfficeIMO HTML conversion document.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- Shared HTML conversion document.
- options OfficeIMO.Word.Html.HtmlToWordOptions = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor for cancellation requests.
Returns
A new WordDocument instance.
public static HtmlToWordResult ToWordDocumentResult(HtmlConversionDocument document, HtmlToWordOptions options = null) #Returns:
HtmlToWordResultImports a prepared shared HTML document into Word and returns structured evidence.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Word.Html.HtmlToWordOptions = null
public static async Task<HtmlToWordResult> ToWordDocumentResultAsync(HtmlConversionDocument document, HtmlToWordOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<HtmlToWordResult>Asynchronously imports a prepared shared HTML document into Word and returns structured evidence.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Word.Html.HtmlToWordOptions = null
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object