OneNoteHtmlConverterExtensions
OfficeIMO.OneNote.Html
Converts typed offline OneNote models to HTML through the shared Markdown model.
Inheritance
- object
- OneNoteHtmlConverterExtensions
Methods
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
- path string
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- stream System.IO.Stream
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- path string
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- stream System.IO.Stream
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- path string
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- stream System.IO.Stream
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- path string
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- stream System.IO.Stream
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>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
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic 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
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic 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
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic 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
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic 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
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<string>>