Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OneNoteNotebookPdfConverterExtensions

OfficeIMO.OneNote.Pdf

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

Converts offline OneNote notebooks to semantic PDF documents.

Inheritance

  • object
  • OneNoteNotebookPdfConverterExtensions

Methods

SaveAsPdf 2 overloads
public static OfficeConversionReport SaveAsPdf(OneNoteNotebook notebook, string path, OneNotePdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes the OneNote notebook as a PDF file and returns the complete conversion report.

Parameters

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

Returns

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

Writes the OneNote notebook as PDF to a caller-owned stream and returns the complete conversion report.

Parameters

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

Returns

OfficeConversionReport
SaveAsPdfAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsPdfAsync(OneNoteNotebook notebook, string path, OneNotePdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the OneNote notebook as a PDF file and returns the complete conversion report.

Parameters

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

Returns

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

Asynchronously writes the OneNote notebook as PDF to a caller-owned stream and returns the complete conversion report.

Parameters

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

Returns

Task<OfficeConversionReport>
ToPdf 2 overloads
public static PdfDocument ToPdf(OneNoteNotebook notebook, OneNotePdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the OneNote notebook to a PDF model.

Parameters

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

Returns

PdfDocument
public static PdfDocument ToPdf(OneNoteNotebook notebook, OneNotePdfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts the OneNote notebook and returns its completed conversion findings.

Parameters

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

Returns

PdfDocument
public static async Task<OfficeConversionResult<PdfDocument>> ToPdfAsync(OneNoteNotebook notebook, OneNotePdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the OneNote notebook, returning the model and report together.

Parameters

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

Returns

Task<OfficeConversionResult<PdfDocument>>