Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OneNoteHtmlConverterExtensions

OfficeIMO.OneNote.Html

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

Converts typed offline OneNote models to HTML through the shared Markdown model.

Inheritance

  • object
  • OneNoteHtmlConverterExtensions

Methods

SaveAsHtml 4 overloads
public static OfficeConversionReport SaveAsHtml(OneNoteSection section, string path, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes the converted output to a path and returns the conversion report.

Parameters

section OfficeIMO.OneNote.OneNoteSection required
path string required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsHtml(OneNoteSection section, Stream stream, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes the converted output to a caller-owned stream, which stays open and returns the conversion report.

Parameters

section OfficeIMO.OneNote.OneNoteSection required
stream System.IO.Stream required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsHtml(OneNoteNotebook notebook, string path, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes the converted output to a path and returns the conversion report.

Parameters

notebook OfficeIMO.OneNote.OneNoteNotebook required
path string required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsHtml(OneNoteNotebook notebook, Stream stream, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes the converted output to a caller-owned stream, which stays open and returns the conversion report.

Parameters

notebook OfficeIMO.OneNote.OneNoteNotebook required
stream System.IO.Stream required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsHtmlAsync 4 overloads
public static async Task<OfficeConversionReport> SaveAsHtmlAsync(OneNoteSection section, string path, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a path and returns the conversion report.

Parameters

section OfficeIMO.OneNote.OneNoteSection required
path string required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsHtmlAsync(OneNoteSection section, Stream stream, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a caller-owned stream and returns the conversion report.

Parameters

section OfficeIMO.OneNote.OneNoteSection required
stream System.IO.Stream required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsHtmlAsync(OneNoteNotebook notebook, string path, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a path and returns the conversion report.

Parameters

notebook OfficeIMO.OneNote.OneNoteNotebook required
path string required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsHtmlAsync(OneNoteNotebook notebook, Stream stream, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the converted output to a caller-owned stream and returns the conversion report.

Parameters

notebook OfficeIMO.OneNote.OneNoteNotebook required
stream System.IO.Stream required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToHtml 4 overloads
public static string ToHtml(OneNoteSection section, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a section to semantic HTML through the shared Markdown model.

Parameters

section OfficeIMO.OneNote.OneNoteSection required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

string
public static string ToHtml(OneNoteSection section, OneNoteHtmlExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts a section to semantic HTML through the shared Markdown model and returns the completed conversion report.

Parameters

section OfficeIMO.OneNote.OneNoteSection required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

string
public static string ToHtml(OneNoteNotebook notebook, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a notebook to semantic HTML through the shared Markdown model.

Parameters

notebook OfficeIMO.OneNote.OneNoteNotebook required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

string
public static string ToHtml(OneNoteNotebook notebook, OneNoteHtmlExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts a notebook to semantic HTML through the shared Markdown model and returns the completed conversion report.

Parameters

notebook OfficeIMO.OneNote.OneNoteNotebook required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

string
ToHtmlAsync 2 overloads
public static Task<OfficeConversionResult<string>> ToHtmlAsync(OneNoteSection section, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a section to semantic HTML through the shared Markdown model, returning the value and report together.

Parameters

section OfficeIMO.OneNote.OneNoteSection required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<string>>
public static Task<OfficeConversionResult<string>> ToHtmlAsync(OneNoteNotebook notebook, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a notebook to semantic HTML through the shared Markdown model, returning the value and report together.

Parameters

notebook OfficeIMO.OneNote.OneNoteNotebook required
options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<string>>