Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OneNoteVisualHtmlExtensions

Namespace OfficeIMO.OneNote.Html
Assembly OfficeIMO.OneNote.Html
Modifiers static

Visual-preserving HTML entry points backed by the native OneNote Drawing canvas.

Inheritance

  • Object
  • OneNoteVisualHtmlExtensions

Methods

SaveAsVisualHtml 4 overloads
public static Void SaveAsVisualHtml(OneNoteSection section, String path, OneNoteVisualHtmlOptions options = null) #
Returns: Void

Saves a section's visual HTML document.

Parameters

arg1 OfficeIMO.OneNote.OneNoteSection requiredposition: 0
arg2 System.String requiredposition: 1
arg3 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 2
public static Void SaveAsVisualHtml(OneNoteNotebook notebook, String path, OneNoteVisualHtmlOptions options = null) #
Returns: Void

Saves a notebook's visual HTML document.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 System.String requiredposition: 1
arg3 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 2
public static Void SaveAsVisualHtml(OneNoteSection section, Stream stream, OneNoteVisualHtmlOptions options = null) #
Returns: Void

Writes a section's visual HTML document to a caller-owned stream.

Parameters

arg1 OfficeIMO.OneNote.OneNoteSection requiredposition: 0
arg2 System.IO.Stream requiredposition: 1
arg3 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 2
public static Void SaveAsVisualHtml(OneNoteNotebook notebook, Stream stream, OneNoteVisualHtmlOptions options = null) #
Returns: Void

Writes a notebook's visual HTML document to a caller-owned stream.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 System.IO.Stream requiredposition: 1
arg3 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 2
SaveAsVisualHtmlAsync 4 overloads
public static Task SaveAsVisualHtmlAsync(OneNoteSection section, String path, OneNoteVisualHtmlOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task

Asynchronously saves a section's visual HTML document.

Parameters

arg1 OfficeIMO.OneNote.OneNoteSection requiredposition: 0
arg2 System.String requiredposition: 1
arg3 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static Task SaveAsVisualHtmlAsync(OneNoteNotebook notebook, String path, OneNoteVisualHtmlOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task

Asynchronously saves a notebook's visual HTML document.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 System.String requiredposition: 1
arg3 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static Task SaveAsVisualHtmlAsync(OneNoteSection section, Stream stream, OneNoteVisualHtmlOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task

Asynchronously writes a section's visual HTML document to a caller-owned stream.

Parameters

arg1 OfficeIMO.OneNote.OneNoteSection requiredposition: 0
arg2 System.IO.Stream requiredposition: 1
arg3 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static Task SaveAsVisualHtmlAsync(OneNoteNotebook notebook, Stream stream, OneNoteVisualHtmlOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task

Asynchronously writes a notebook's visual HTML document to a caller-owned stream.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 System.IO.Stream requiredposition: 1
arg3 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
ToVisualHtmlBytes 2 overloads
public static Byte[] ToVisualHtmlBytes(OneNoteSection section, OneNoteVisualHtmlOptions options = null) #
Returns: Byte[]

Encodes a section's visual HTML document as UTF-8 without a byte-order mark.

Parameters

arg1 OfficeIMO.OneNote.OneNoteSection requiredposition: 0
arg2 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 1
public static Byte[] ToVisualHtmlBytes(OneNoteNotebook notebook, OneNoteVisualHtmlOptions options = null) #
Returns: Byte[]

Encodes a notebook's visual HTML document as UTF-8 without a byte-order mark.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 1
ToVisualHtmlDocument 2 overloads
public static String ToVisualHtmlDocument(OneNoteSection section, OneNoteVisualHtmlOptions options = null) #
Returns: String

Converts a section to a standalone responsive HTML5 document containing one SVG canvas per page.

Parameters

arg1 OfficeIMO.OneNote.OneNoteSection requiredposition: 0
arg2 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 1
public static String ToVisualHtmlDocument(OneNoteNotebook notebook, OneNoteVisualHtmlOptions options = null) #
Returns: String

Converts a notebook to a standalone responsive HTML5 document containing one SVG canvas per page.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 1
ToVisualHtmlFragment 2 overloads
public static String ToVisualHtmlFragment(OneNoteSection section, OneNoteVisualHtmlOptions options = null) #
Returns: String

Converts a section to an embeddable responsive SVG-page fragment.

Parameters

arg1 OfficeIMO.OneNote.OneNoteSection requiredposition: 0
arg2 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 1
public static String ToVisualHtmlFragment(OneNoteNotebook notebook, OneNoteVisualHtmlOptions options = null) #
Returns: String

Converts a notebook to an embeddable responsive SVG-page fragment.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 OfficeIMO.OneNote.Html.OneNoteVisualHtmlOptions = null optionalposition: 1