OneNoteVisualHtmlExtensions
OfficeIMO.OneNote.Html
Visual-preserving HTML entry points backed by the native OneNote Drawing canvas.
Inheritance
- object
- OneNoteVisualHtmlExtensions
Methods
public static OfficeConversionReport SaveAsVisualHtml(OneNoteSection section, string path, OneNoteVisualHtmlExportOptions? 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.OneNoteVisualHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsVisualHtml(OneNoteSection section, Stream stream, OneNoteVisualHtmlExportOptions? 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.OneNoteVisualHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsVisualHtml(OneNoteNotebook notebook, string path, OneNoteVisualHtmlExportOptions? 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.OneNoteVisualHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsVisualHtml(OneNoteNotebook notebook, Stream stream, OneNoteVisualHtmlExportOptions? 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.OneNoteVisualHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static async Task<OfficeConversionReport> SaveAsVisualHtmlAsync(OneNoteSection section, string path, OneNoteVisualHtmlExportOptions? 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.OneNoteVisualHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static async Task<OfficeConversionReport> SaveAsVisualHtmlAsync(OneNoteSection section, Stream stream, OneNoteVisualHtmlExportOptions? 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.OneNoteVisualHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static async Task<OfficeConversionReport> SaveAsVisualHtmlAsync(OneNoteNotebook notebook, string path, OneNoteVisualHtmlExportOptions? 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.OneNoteVisualHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static async Task<OfficeConversionReport> SaveAsVisualHtmlAsync(OneNoteNotebook notebook, Stream stream, OneNoteVisualHtmlExportOptions? 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.OneNoteVisualHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static string ToVisualHtml(OneNoteSection section, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Converts a section to visual HTML with one SVG canvas per page.
Parameters
- section OfficeIMO.OneNote.OneNoteSection
- options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic static string ToVisualHtml(OneNoteSection section, OneNoteVisualHtmlExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Converts a section to visual HTML with one SVG canvas per page and returns the completed conversion report.
Parameters
- section OfficeIMO.OneNote.OneNoteSection
- options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic static string ToVisualHtml(OneNoteNotebook notebook, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Converts a notebook to visual HTML with one SVG canvas per page.
Parameters
- notebook OfficeIMO.OneNote.OneNoteNotebook
- options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic static string ToVisualHtml(OneNoteNotebook notebook, OneNoteVisualHtmlExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Converts a notebook to visual HTML with one SVG canvas per page and returns the completed conversion report.
Parameters
- notebook OfficeIMO.OneNote.OneNoteNotebook
- options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic static Task<OfficeConversionResult<string>> ToVisualHtmlAsync(OneNoteSection section, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Converts a section to visual HTML with one SVG canvas per page, returning the value and report together.
Parameters
- section OfficeIMO.OneNote.OneNoteSection
- options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<string>>public static Task<OfficeConversionResult<string>> ToVisualHtmlAsync(OneNoteNotebook notebook, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default) #Converts a notebook to visual HTML with one SVG canvas per page, returning the value and report together.
Parameters
- notebook OfficeIMO.OneNote.OneNoteNotebook
- options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<string>>