Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

WordHtmlConverterExtensions

OfficeIMO.Word.Html

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

Extension methods enabling HTML conversions for WordDocument instances.

Inheritance

  • object
  • WordHtmlConverterExtensions

Methods

AddHtml 6 overloads
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 required
Document to modify.
htmlDocument OfficeIMO.Html.HtmlConversionDocument required
Parsed HTML source to insert.
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
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 required
Header to modify.
htmlDocument OfficeIMO.Html.HtmlConversionDocument required
Parsed HTML source to insert.
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
Optional conversion options.
section OfficeIMO.Word.WordSection? = null optional
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(WordFooter footer, HtmlConversionDocument htmlDocument, HtmlWordExportOptions? options = null, WordSection? section = null) #

Appends offline HTML to a footer and returns the created elements.

Parameters

footer OfficeIMO.Word.WordFooter required
Footer to modify.
htmlDocument OfficeIMO.Html.HtmlConversionDocument required
Parsed HTML source to insert.
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
Optional conversion options.
section OfficeIMO.Word.WordSection? = null optional
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 required
Target to modify.
html string required
HTML source text, parsed with untrusted input limits and policies.
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
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 required
Target to modify.
html string required
HTML source text, parsed with untrusted input limits and policies.
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
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 required
Table cell to modify.
htmlDocument OfficeIMO.Html.HtmlConversionDocument required
Parsed HTML source to insert.
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
Optional conversion options.

Returns

IReadOnlyList<WordElement> Live imported elements in document order, using the existing Word element projection.
AddHtmlAsync 6 overloads
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 required
Document to modify.
htmlDocument OfficeIMO.Html.HtmlConversionDocument required
Parsed HTML source to insert.
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
Optional conversion options.
cancellationToken System.Threading.CancellationToken = default optional
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 required
Header to modify.
htmlDocument OfficeIMO.Html.HtmlConversionDocument required
Parsed HTML source to insert.
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
Optional conversion options.
section OfficeIMO.Word.WordSection? = null optional
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 optional
Token to monitor for cancellation requests.

Returns

Task<IReadOnlyList<WordElement>> New live elements in story order, using the existing Word element projection.
public static async Task<IReadOnlyList<WordElement>> AddHtmlAsync(WordFooter footer, HtmlConversionDocument htmlDocument, HtmlWordExportOptions? options = null, WordSection? section = null, CancellationToken cancellationToken = default) #

Asynchronously appends HTML to a footer and returns the created elements.

Parameters

footer OfficeIMO.Word.WordFooter required
Footer to modify.
htmlDocument OfficeIMO.Html.HtmlConversionDocument required
Parsed HTML source to insert.
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
Optional conversion options.
section OfficeIMO.Word.WordSection? = null optional
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 optional
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 required
Target to modify.
html string required
HTML source text, parsed with untrusted input limits and policies.
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
Optional conversion options.
cancellationToken System.Threading.CancellationToken = default optional
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 required
Target to modify.
html string required
HTML source text, parsed with untrusted input limits and policies.
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
Optional conversion options.
cancellationToken System.Threading.CancellationToken = default optional
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 required
Table cell to modify.
htmlDocument OfficeIMO.Html.HtmlConversionDocument required
Parsed HTML source to insert.
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
Optional conversion options.
cancellationToken System.Threading.CancellationToken = default optional
Token to monitor for cancellation requests.

Returns

Task<IReadOnlyList<WordElement>> Live imported elements in document order, using the existing Word element projection.
SaveAsHtml 2 overloads
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 required
path string required
options OfficeIMO.Word.Html.WordHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public 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 required
stream System.IO.Stream required
options OfficeIMO.Word.Html.WordHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsHtmlAsync 2 overloads
public 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 required
path string required
options OfficeIMO.Word.Html.WordHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

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 required
stream System.IO.Stream required
options OfficeIMO.Word.Html.WordHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
SaveAsWord 2 overloads
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 required
path string required
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public 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 required
stream System.IO.Stream required
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsWordAsync 2 overloads
public 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 required
path string required
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

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 required
stream System.IO.Stream required
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToHtml 2 overloads
public static string ToHtml(WordDocument document, WordHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts Word to HTML text.

Parameters

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

Returns

string
public 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 required
options OfficeIMO.Word.Html.WordHtmlExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

string
public 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 required
options OfficeIMO.Word.Html.WordHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<string>>
ToWord 2 overloads
public static WordDocument ToWord(HtmlConversionDocument document, HtmlWordExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts prepared HTML into a Word document.

Parameters

document OfficeIMO.Html.HtmlConversionDocument required
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

WordDocument
public 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 required
options OfficeIMO.Word.Html.HtmlWordExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

WordDocument
public 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 required
options OfficeIMO.Word.Html.HtmlWordExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<WordDocument>>