Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OneNoteMarkdownConverterExtensions

OfficeIMO.OneNote.Markdown

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

Converts typed offline OneNote models through the first-party Markdown model.

Inheritance

  • object
  • OneNoteMarkdownConverterExtensions

Methods

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

Writes the section's Markdown projection as UTF-8 to a path and returns the conversion report.

Parameters

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

Returns

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

Writes the section's Markdown projection as UTF-8 to a caller-owned stream and returns the conversion report.

Parameters

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

Returns

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

Writes the notebook's Markdown projection as UTF-8 to a path and returns the conversion report.

Parameters

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

Returns

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

Writes the notebook's Markdown projection as UTF-8 to a caller-owned stream and returns the conversion report.

Parameters

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

Returns

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

Asynchronously writes the section's Markdown projection as UTF-8.

Parameters

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

Returns

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

Asynchronously writes the section's Markdown projection as UTF-8.

Parameters

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

Returns

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

Asynchronously writes the notebook's Markdown projection as UTF-8.

Parameters

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

Returns

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

Asynchronously writes the notebook's Markdown projection as UTF-8.

Parameters

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

Returns

Task<OfficeConversionReport>
ToMarkdown 4 overloads
public static MarkdownDocument ToMarkdown(OneNoteSection section, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a section to a Markdown document.

Parameters

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

Returns

MarkdownDocument
public static MarkdownDocument ToMarkdown(OneNoteSection section, OneNoteMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts a section to a Markdown document and returns the completed conversion report.

Parameters

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

Returns

MarkdownDocument
public static MarkdownDocument ToMarkdown(OneNoteNotebook notebook, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a notebook to a Markdown document.

Parameters

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

Returns

MarkdownDocument
public static MarkdownDocument ToMarkdown(OneNoteNotebook notebook, OneNoteMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts a notebook to a Markdown document and returns the completed conversion report.

Parameters

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

Returns

MarkdownDocument
ToMarkdownAsync 2 overloads
public static Task<OfficeConversionResult<MarkdownDocument>> ToMarkdownAsync(OneNoteSection section, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a section to a Markdown document, returning the value and report together.

Parameters

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

Returns

Task<OfficeConversionResult<MarkdownDocument>>
public static Task<OfficeConversionResult<MarkdownDocument>> ToMarkdownAsync(OneNoteNotebook notebook, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts a notebook to a Markdown document, returning the value and report together.

Parameters

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

Returns

Task<OfficeConversionResult<MarkdownDocument>>