Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OneNoteNotebookPdfConverterExtensions

Namespace OfficeIMO.OneNote.Pdf
Assembly OfficeIMO.OneNote.Pdf
Modifiers static

Converts offline OneNote notebooks to semantic PDF documents.

Inheritance

  • Object
  • OneNoteNotebookPdfConverterExtensions

Methods

SaveAsPdf 2 overloads
public static PdfSaveResult SaveAsPdf(OneNoteNotebook notebook, String path, OneNoteToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: PdfSaveResult

Saves a notebook as PDF and returns conversion diagnostics.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 System.String requiredposition: 1
arg3 OfficeIMO.OneNote.Pdf.OneNoteToPdfOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static PdfSaveResult SaveAsPdf(OneNoteNotebook notebook, Stream stream, OneNoteToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: PdfSaveResult

Writes a notebook as PDF to a caller-owned stream.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 System.IO.Stream requiredposition: 1
arg3 OfficeIMO.OneNote.Pdf.OneNoteToPdfOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
SaveAsPdfAsync 2 overloads
public static Task<PdfSaveResult> SaveAsPdfAsync(OneNoteNotebook notebook, String path, OneNoteToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task<PdfSaveResult>

Converts synchronously, then asynchronously writes a notebook PDF to a path.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 System.String requiredposition: 1
arg3 OfficeIMO.OneNote.Pdf.OneNoteToPdfOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static Task<PdfSaveResult> SaveAsPdfAsync(OneNoteNotebook notebook, Stream stream, OneNoteToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task<PdfSaveResult>

Converts synchronously, then asynchronously writes a notebook PDF to a caller-owned stream.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 System.IO.Stream requiredposition: 1
arg3 OfficeIMO.OneNote.Pdf.OneNoteToPdfOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
SaveAsPdfResult 2 overloads
public static PdfSaveResult SaveAsPdfResult(OneNoteNotebook notebook, String path, OneNoteToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: PdfSaveResult

Attempts to save a notebook as PDF and returns structured failure evidence.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 System.String requiredposition: 1
arg3 OfficeIMO.OneNote.Pdf.OneNoteToPdfOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static PdfSaveResult SaveAsPdfResult(OneNoteNotebook notebook, Stream stream, OneNoteToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: PdfSaveResult

Attempts to write a notebook as PDF to a caller-owned stream.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 System.IO.Stream requiredposition: 1
arg3 OfficeIMO.OneNote.Pdf.OneNoteToPdfOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
SaveAsPdfResultAsync 2 overloads
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(OneNoteNotebook notebook, String path, OneNoteToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task<PdfSaveResult>

Converts synchronously, then attempts to asynchronously save a notebook PDF.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 System.String requiredposition: 1
arg3 OfficeIMO.OneNote.Pdf.OneNoteToPdfOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(OneNoteNotebook notebook, Stream stream, OneNoteToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: Task<PdfSaveResult>

Converts synchronously, then attempts to asynchronously write a notebook PDF.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 System.IO.Stream requiredposition: 1
arg3 OfficeIMO.OneNote.Pdf.OneNoteToPdfOptions = null optionalposition: 2
arg4 System.Threading.CancellationToken = default optionalposition: 3
public static Byte[] ToPdfBytes(OneNoteNotebook notebook, OneNoteToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: Byte[]

Converts a notebook to PDF bytes.

Parameters

notebook OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
options OfficeIMO.OneNote.Pdf.OneNoteToPdfOptions = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public static PdfDocument ToPdfDocument(OneNoteNotebook notebook, OneNoteToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: PdfDocument

Converts a notebook to a first-party PDF document.

Parameters

notebook OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
options OfficeIMO.OneNote.Pdf.OneNoteToPdfOptions = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public static PdfDocumentConversionResult ToPdfDocumentResult(OneNoteNotebook notebook, OneNoteToPdfOptions options = null, CancellationToken cancellationToken = default) #
Returns: PdfDocumentConversionResult

Converts a notebook and returns explicit source, projection, and PDF diagnostics.

Parameters

notebook OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
options OfficeIMO.OneNote.Pdf.OneNoteToPdfOptions = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2