Get Started

API Reference

Class

OneNoteImageExportExtensions

Edit on GitHub
Namespace OfficeIMO.OneNote
Assembly OfficeIMO.OneNote
Source OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:99
Modifiers static

OneNote page rendering and image-export entry points.

Inheritance

  • Object
  • OneNoteImageExportExtensions

Methods

public static OfficeImageExportResult ExportImage(OneNotePage page, OfficeImageExportFormat format, OneNotePageRenderingOptions options = null, CancellationToken cancellationToken = null) #
OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:99
Returns: OfficeImageExportResult

Exports a page using the shared five-format result contract.

Parameters

page OfficeIMO.OneNote.OneNotePage requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.OneNote.OneNotePageRenderingOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
ExportImages 2 overloads
public static IReadOnlyList<OfficeImageExportResult> ExportImages(OneNoteSection section, OfficeImageExportFormat format, OneNotePageBatchRenderingOptions options = null) #
OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:110
Returns: IReadOnlyList<OfficeImageExportResult>

Exports selected section pages using the shared five-format result contract.

Parameters

arg1 OfficeIMO.OneNote.OneNoteSection requiredposition: 0
arg2 OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
arg3 OfficeIMO.OneNote.OneNotePageBatchRenderingOptions = null optionalposition: 2
public static IReadOnlyList<OfficeImageExportResult> ExportImages(OneNoteNotebook notebook, OfficeImageExportFormat format, OneNotePageBatchRenderingOptions options = null) #
OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:120
Returns: IReadOnlyList<OfficeImageExportResult>

Exports selected notebook pages using the shared five-format result contract.

Parameters

arg1 OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
arg2 OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
arg3 OfficeIMO.OneNote.OneNotePageBatchRenderingOptions = null optionalposition: 2
public static OfficeDrawing ToDrawing(OneNotePage page, OneNotePageRenderingOptions options = null) #
OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:147
Returns: OfficeDrawing

Creates the reusable Drawing scene for a page.

Parameters

page OfficeIMO.OneNote.OneNotePage requiredposition: 0
options OfficeIMO.OneNote.OneNotePageRenderingOptions = null optionalposition: 1
ToImage 2 overloads
public static OneNotePageImageExportBuilder ToImage(OneNotePage page) #
OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:126
Returns: OneNotePageImageExportBuilder

Starts fluent PNG/JPEG/TIFF/SVG/WebP export for a page.

Parameters

page OfficeIMO.OneNote.OneNotePage requiredposition: 0
public static OneNotePageImageExportBuilder ToImage(OneNotePage page, OneNotePageRenderingOptions options) #
OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:130
Returns: OneNotePageImageExportBuilder

Starts fluent export using a cloned options snapshot.

Parameters

page OfficeIMO.OneNote.OneNotePage requiredposition: 0
options OfficeIMO.OneNote.OneNotePageRenderingOptions requiredposition: 1
ToImages 4 overloads
public static OneNotePageImageBatchExportBuilder ToImages(OneNoteSection section) #
OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:133
Returns: OneNotePageImageBatchExportBuilder

Starts batch PNG/JPEG/TIFF/SVG/WebP export for all section pages.

Parameters

section OfficeIMO.OneNote.OneNoteSection requiredposition: 0
public static OneNotePageImageBatchExportBuilder ToImages(OneNoteSection section, OneNotePageBatchRenderingOptions options) #
OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:137
Returns: OneNotePageImageBatchExportBuilder

Starts batch export using a cloned options snapshot.

Parameters

section OfficeIMO.OneNote.OneNoteSection requiredposition: 0
options OfficeIMO.OneNote.OneNotePageBatchRenderingOptions requiredposition: 1
public static OneNotePageImageBatchExportBuilder ToImages(OneNoteNotebook notebook) #
OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:140
Returns: OneNotePageImageBatchExportBuilder

Starts batch PNG/JPEG/TIFF/SVG/WebP export for all notebook pages.

Parameters

notebook OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
public static OneNotePageImageBatchExportBuilder ToImages(OneNoteNotebook notebook, OneNotePageBatchRenderingOptions options) #
OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:144
Returns: OneNotePageImageBatchExportBuilder

Starts batch export using a cloned options snapshot.

Parameters

notebook OfficeIMO.OneNote.OneNoteNotebook requiredposition: 0
options OfficeIMO.OneNote.OneNotePageBatchRenderingOptions requiredposition: 1