WordHtmlConverterExtensions
OfficeIMO.Word.Html
Extension methods enabling HTML conversions for WordDocument instances.
Inheritance
- object
- WordHtmlConverterExtensions
Methods
public static IReadOnlyList<WordElement> AddHtml(WordDocument doc, HtmlConversionDocument htmlDocument, HtmlWordExportOptions? options = null) #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.HtmlWordExportOptions? = null
- Optional conversion options.
Returns
IReadOnlyList<WordElement> Live imported elements in document order, using the existing Word element projection.public static IReadOnlyList<WordElement> AddHtml(WordHeader header, HtmlConversionDocument htmlDocument, HtmlWordExportOptions? options = null, WordSection? section = null) #Appends offline HTML to a header and returns the created elements.
Parameters
- header OfficeIMO.Word.WordHeader
- Header to modify.
- htmlDocument OfficeIMO.Html.HtmlConversionDocument
- Parsed HTML source to insert.
- options OfficeIMO.Word.Html.HtmlWordExportOptions? = null
- Optional conversion options.
- section OfficeIMO.Word.WordSection? = null
- Section supplying layout geometry. Defaults to the first section defining this story; an explicit section must share or inherit it.
Returns
IReadOnlyList<WordElement> New live elements in story order, using the existing Word element projection.public static IReadOnlyList<WordElement> AddHtml(WordDocument doc, string html, HtmlWordExportOptions? options = null) #Parses and appends HTML to the document body.
Parameters
- doc OfficeIMO.Word.WordDocument
- Target to modify.
- html string
- HTML source text, parsed with untrusted input limits and policies.
- options OfficeIMO.Word.Html.HtmlWordExportOptions? = null
- Optional conversion options.
Returns
IReadOnlyList<WordElement> Live imported elements in document order, using the existing Word element projection.public static IReadOnlyList<WordElement> AddHtml(WordTableCell cell, string html, HtmlWordExportOptions? options = null) #Parses and appends HTML to the table cell.
Parameters
- cell OfficeIMO.Word.WordTableCell
- Target to modify.
- html string
- HTML source text, parsed with untrusted input limits and policies.
- options OfficeIMO.Word.Html.HtmlWordExportOptions? = null
- Optional conversion options.
Returns
IReadOnlyList<WordElement> Live imported elements in document order, using the existing Word element projection.public static IReadOnlyList<WordElement> AddHtml(WordTableCell cell, HtmlConversionDocument htmlDocument, HtmlWordExportOptions? options = null) #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.HtmlWordExportOptions? = null
- Optional conversion options.
Returns
IReadOnlyList<WordElement> Live imported elements in document order, using the existing Word element projection.public static async Task<IReadOnlyList<WordElement>> AddHtmlAsync(WordDocument doc, HtmlConversionDocument htmlDocument, HtmlWordExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously 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.HtmlWordExportOptions? = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor for cancellation requests.
Returns
Task<IReadOnlyList<WordElement>> Live imported elements in document order, using the existing Word element projection.public static async Task<IReadOnlyList<WordElement>> AddHtmlAsync(WordHeader header, HtmlConversionDocument htmlDocument, HtmlWordExportOptions? options = null, WordSection? section = null, CancellationToken cancellationToken = default) #Asynchronously appends HTML to a header and returns the created elements.
Parameters
- header OfficeIMO.Word.WordHeader
- Header to modify.
- htmlDocument OfficeIMO.Html.HtmlConversionDocument
- Parsed HTML source to insert.
- options OfficeIMO.Word.Html.HtmlWordExportOptions? = null
- Optional conversion options.
- section OfficeIMO.Word.WordSection? = null
- Section supplying layout geometry. Defaults to the first section defining this story; an explicit section must share or inherit it.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor for cancellation requests.
Returns
Task<IReadOnlyList<WordElement>> New live elements in story order, using the existing Word element projection.public static Task<IReadOnlyList<WordElement>> AddHtmlAsync(WordDocument doc, string html, HtmlWordExportOptions? options = null, CancellationToken cancellationToken = default) #Parses and asynchronously appends HTML to the document body.
Parameters
- doc OfficeIMO.Word.WordDocument
- Target to modify.
- html string
- HTML source text, parsed with untrusted input limits and policies.
- options OfficeIMO.Word.Html.HtmlWordExportOptions? = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor for cancellation requests.
Returns
Task<IReadOnlyList<WordElement>> Live imported elements in document order, using the existing Word element projection.public static Task<IReadOnlyList<WordElement>> AddHtmlAsync(WordTableCell cell, string html, HtmlWordExportOptions? options = null, CancellationToken cancellationToken = default) #Parses and asynchronously appends HTML to the table cell.
Parameters
- cell OfficeIMO.Word.WordTableCell
- Target to modify.
- html string
- HTML source text, parsed with untrusted input limits and policies.
- options OfficeIMO.Word.Html.HtmlWordExportOptions? = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor for cancellation requests.
Returns
Task<IReadOnlyList<WordElement>> Live imported elements in document order, using the existing Word element projection.public static async Task<IReadOnlyList<WordElement>> AddHtmlAsync(WordTableCell cell, HtmlConversionDocument htmlDocument, HtmlWordExportOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously 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.HtmlWordExportOptions? = null
- Optional conversion options.
- cancellationToken System.Threading.CancellationToken = default
- Token to monitor for cancellation requests.
Returns
Task<IReadOnlyList<WordElement>> Live imported elements in document order, using the existing Word element projection.public static OfficeConversionReport SaveAsHtml(WordDocument document, string path, WordHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Html content with its completed-stage report.
Parameters
- document OfficeIMO.Word.WordDocument
- path string
- options OfficeIMO.Word.Html.WordHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsHtml(WordDocument document, Stream stream, WordHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Html content with its completed-stage report.
Parameters
- document OfficeIMO.Word.WordDocument
- stream System.IO.Stream
- options OfficeIMO.Word.Html.WordHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static async Task<OfficeConversionReport> SaveAsHtmlAsync(WordDocument document, string path, WordHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Html content with its completed-stage report.
Parameters
- document OfficeIMO.Word.WordDocument
- path string
- options OfficeIMO.Word.Html.WordHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static async Task<OfficeConversionReport> SaveAsHtmlAsync(WordDocument document, Stream stream, WordHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Html content with its completed-stage report.
Parameters
- document OfficeIMO.Word.WordDocument
- stream System.IO.Stream
- options OfficeIMO.Word.Html.WordHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static OfficeConversionReport SaveAsWord(HtmlConversionDocument document, string path, HtmlWordExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Word content with its completed-stage report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Word.Html.HtmlWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsWord(HtmlConversionDocument document, Stream stream, HtmlWordExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Word content with its completed-stage report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Word.Html.HtmlWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static async Task<OfficeConversionReport> SaveAsWordAsync(HtmlConversionDocument document, string path, HtmlWordExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Word content with its completed-stage report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Word.Html.HtmlWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static async Task<OfficeConversionReport> SaveAsWordAsync(HtmlConversionDocument document, Stream stream, HtmlWordExportOptions? options = null, CancellationToken cancellationToken = default) #Saves converted Word content with its completed-stage report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Word.Html.HtmlWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static string ToHtml(WordDocument document, WordHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Converts Word to HTML text.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Word.Html.WordHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic static string ToHtml(WordDocument document, WordHtmlExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Converts Word to HTML text and returns completed-stage findings.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Word.Html.WordHtmlExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic static async Task<OfficeConversionResult<string>> ToHtmlAsync(WordDocument document, WordHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Converts Word to HTML text with its completed-stage report.
Parameters
- document OfficeIMO.Word.WordDocument
- options OfficeIMO.Word.Html.WordHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<string>>public static WordDocument ToWord(HtmlConversionDocument document, HtmlWordExportOptions? options = null, CancellationToken cancellationToken = default) #Converts prepared HTML into a Word document.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Word.Html.HtmlWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
WordDocumentpublic static WordDocument ToWord(HtmlConversionDocument document, HtmlWordExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Converts prepared HTML into Word and returns completed-stage findings.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Word.Html.HtmlWordExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
WordDocumentpublic static async Task<OfficeConversionResult<WordDocument>> ToWordAsync(HtmlConversionDocument document, HtmlWordExportOptions? options = null, CancellationToken cancellationToken = default) #Converts prepared HTML into Word with its completed-stage report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Word.Html.HtmlWordExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<WordDocument>>