OneNoteMarkdownConverterExtensions
OfficeIMO.OneNote.Markdown
Converts typed offline OneNote models through the first-party Markdown model.
Inheritance
- object
- OneNoteMarkdownConverterExtensions
Methods
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
- path string
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- stream System.IO.Stream
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- path string
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- stream System.IO.Stream
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic 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
- path string
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- stream System.IO.Stream
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- path string
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- stream System.IO.Stream
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static MarkdownDocument ToMarkdown(OneNoteSection section, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Converts a section to a Markdown document.
Parameters
- section OfficeIMO.OneNote.OneNoteSection
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic 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
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic static MarkdownDocument ToMarkdown(OneNoteNotebook notebook, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default) #Converts a notebook to a Markdown document.
Parameters
- notebook OfficeIMO.OneNote.OneNoteNotebook
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic 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
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
MarkdownDocumentpublic 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
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
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
- options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<MarkdownDocument>>