Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OneNoteVisualPdfExtensions

OfficeIMO.OneNote.Pdf

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

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

Inheritance

  • object
  • OneNoteVisualPdfExtensions

Methods

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

Writes the OneNote section as page images as a PDF file and returns the complete conversion report.

Parameters

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

Returns

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

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

Parameters

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

Returns

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

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

Parameters

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

Returns

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

Writes the OneNote notebook as page images 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.OneNoteVisualPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Asynchronously writes the OneNote section as page images as a PDF file and returns the complete conversion report.

Parameters

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

Returns

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

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

Parameters

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

Returns

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

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

Parameters

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

Returns

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

Asynchronously writes the OneNote notebook as page images 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.OneNoteVisualPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToVisualPdf 4 overloads
public static PdfDocument ToVisualPdf(OneNoteSection section, OneNoteVisualPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the OneNote section as page images to a PDF model.

Parameters

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

Returns

PdfDocument
public static PdfDocument ToVisualPdf(OneNoteSection section, OneNoteVisualPdfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts the OneNote section as page images and returns its completed conversion findings.

Parameters

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

Returns

PdfDocument
public static PdfDocument ToVisualPdf(OneNoteNotebook notebook, OneNoteVisualPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the OneNote notebook as page images to a PDF model.

Parameters

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

Returns

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

Converts the OneNote notebook as page images and returns its completed conversion findings.

Parameters

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

Returns

PdfDocument
ToVisualPdfAsync 2 overloads
public static async Task<OfficeConversionResult<PdfDocument>> ToVisualPdfAsync(OneNoteSection section, OneNoteVisualPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the OneNote section as page images, returning the model and report together.

Parameters

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

Returns

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

Converts the OneNote notebook as page images, returning the model and report together.

Parameters

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

Returns

Task<OfficeConversionResult<PdfDocument>>