API Reference

Class

OneNotePageImageBatchExportBuilder

Edit on GitHub

Namespace OfficeIMO.OneNote

Assembly OfficeIMO.OneNote

Source OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:68

Base OfficeImageExportBatchBuilder<OneNotePageImageBatchExportBuilder, OneNotePageBatchRenderingOptions>

Modifiers sealed

Fluent batch image export for a OneNote section or notebook.

Inheritance

OfficeImageExportBatchBuilder<OneNotePageImageBatchExportBuilder, OneNotePageBatchRenderingOptions>
OneNotePageImageBatchExportBuilder

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Method OneNoteImageExportExtensions.ToImages
Method OneNoteImageExportExtensions.ToImages
Method OneNoteImageExportExtensions.ToImages
Method OneNoteImageExportExtensions.ToImages
Extension method OneNoteNotebook.ToImages
Extension method OneNoteNotebook.ToImages
Method OneNotePageImageBatchExportBuilder.AllPages
Method OneNotePageImageBatchExportBuilder.As
Method OneNotePageImageBatchExportBuilder.AsJpeg
Method OneNotePageImageBatchExportBuilder.AsPng
Method OneNotePageImageBatchExportBuilder.AsSvg
Method OneNotePageImageBatchExportBuilder.AsTiff
Method OneNotePageImageBatchExportBuilder.AsWebp
Method OneNotePageImageBatchExportBuilder.AtDpi
Method OneNotePageImageBatchExportBuilder.ForPreview
Method OneNotePageImageBatchExportBuilder.ForPrint
Method OneNotePageImageBatchExportBuilder.FromPage
Method OneNotePageImageBatchExportBuilder.IncludeInk
Method OneNotePageImageBatchExportBuilder.IncludeMath
Method OneNotePageImageBatchExportBuilder.OnFileConflict
Method OneNotePageImageBatchExportBuilder.OnRasterOverflow
Method OneNotePageImageBatchExportBuilder.TakePages
Method OneNotePageImageBatchExportBuilder.WithBackground
Method OneNotePageImageBatchExportBuilder.WithBackground
Method OneNotePageImageBatchExportBuilder.WithBatchLimits
Method OneNotePageImageBatchExportBuilder.WithFont
Method OneNotePageImageBatchExportBuilder.WithFonts
Method OneNotePageImageBatchExportBuilder.WithImageCodec
Method OneNotePageImageBatchExportBuilder.WithMaximumConcurrency
Method OneNotePageImageBatchExportBuilder.WithMaximumRasterPixels
Method OneNotePageImageBatchExportBuilder.WithPolicy
Method OneNotePageImageBatchExportBuilder.WithProgress
Method OneNotePageImageBatchExportBuilder.WithRasterEncoding
Method OneNotePageImageBatchExportBuilder.WithScale
Method OneNotePageImageBatchExportBuilder.WithTextShaping
Extension method OneNoteSection.ToImages
Extension method OneNoteSection.ToImages

Methods

public OneNotePageImageBatchExportBuilder AllPages() #

OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:81

Returns: OneNotePageImageBatchExportBuilder

Exports every page from the beginning.

public OneNotePageImageBatchExportBuilder FromPage(Int32 pageIndex) #

OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:68

Returns: OneNotePageImageBatchExportBuilder

Starts with the specified zero-based flattened page index.

Parameters

pageIndex System.Int32 requiredposition: 0

public OneNotePageImageBatchExportBuilder IncludeInk(Boolean include = true) #

OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:84

Returns: OneNotePageImageBatchExportBuilder

Includes or excludes native ink.

Parameters

include System.Boolean = true optionalposition: 0

public OneNotePageImageBatchExportBuilder IncludeMath(Boolean include = true) #

OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:87

Returns: OneNotePageImageBatchExportBuilder

Includes or excludes structured math typesetting.

Parameters

include System.Boolean = true optionalposition: 0

public OneNotePageImageBatchExportBuilder TakePages(Int32 pageCount) #

OfficeIMO.OneNote/Imaging/OneNoteImageExportBuilder.cs:75

Returns: OneNotePageImageBatchExportBuilder

Limits output to the requested number of pages.

Parameters

pageCount System.Int32 requiredposition: 0

Inherited Methods

public OneNotePageImageBatchExportBuilder As(OfficeImageExportFormat format) #

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

format OfficeImageExportFormat requiredposition: 0

public OneNotePageImageBatchExportBuilder AsJpeg() #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.PageGraph.cs:26

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public OneNotePageImageBatchExportBuilder AsPng() #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.PageGraph.cs:6

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public OneNotePageImageBatchExportBuilder AsSvg() #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.PageGraph.cs:14

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public OneNotePageImageBatchExportBuilder AsTiff() #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.PageGraph.cs:36

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public OneNotePageImageBatchExportBuilder AsWebp() #

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public OneNotePageImageBatchExportBuilder AtDpi(Double dpi) #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.cs:208

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

dpi Double requiredposition: 0

public override Boolean Equals(Object obj) #

OfficeIMO.OneNote/Internal/OneStore/OneNotePackageStoreReader.cs:211

Returns: Boolean

Inherited from Object

Parameters

obj Object requiredposition: 0

public IReadOnlyList<OfficeImageExportResult> Export() #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.cs:601

Returns: IReadOnlyList<OfficeImageExportResult>

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public async Task<IReadOnlyList<OfficeImageExportResult>> ExportAsync(CancellationToken cancellationToken = null) #

Returns: Task<IReadOnlyList<OfficeImageExportResult>>

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

cancellationToken CancellationToken = null optionalposition: 0

public Void ExportEach(OfficeImageExportConsumer consumer, CancellationToken cancellationToken = null) #

Returns: Void

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

consumer OfficeImageExportConsumer requiredposition: 0
cancellationToken CancellationToken = null optionalposition: 1

public async Task ExportEachAsync(OfficeImageExportAsyncConsumer consumer, CancellationToken cancellationToken = null) #

Returns: Task

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

consumer OfficeImageExportAsyncConsumer requiredposition: 0
cancellationToken CancellationToken = null optionalposition: 1

public OneNotePageImageBatchExportBuilder ForPreview() #

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

public OneNotePageImageBatchExportBuilder ForPrint(Double dpi = 300) #

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

dpi Double = 300 optionalposition: 0

public override Int32 GetHashCode() #

OfficeIMO.OneNote/Internal/OneStore/OneNotePackageStoreReader.cs:216

Returns: Int32

Inherited from Object

public Type GetType() #

OfficeIMO.OneNote/Internal/OneStore/OneNotePackageStoreReader.cs:203

Returns: Type

Inherited from Object

public OneNotePageImageBatchExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.cs:278

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

policy OfficeImageExportFileConflictPolicy requiredposition: 0

public OneNotePageImageBatchExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.Ink.cs:113

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

behavior OfficeRasterOverflowBehavior requiredposition: 0

public IReadOnlyList<OfficeImageExportResult> Save(String folderPath) #

Returns: IReadOnlyList<OfficeImageExportResult>

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

folderPath String requiredposition: 0

public async Task<IReadOnlyList<OfficeImageExportResult>> SaveAsync(String folderPath, CancellationToken cancellationToken = null)

Returns: Task<IReadOnlyList<OfficeImageExportResult>>

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

folderPath String requiredposition: 0
cancellationToken CancellationToken = null optionalposition: 1

public OfficeImageExportBatchSaveResult SaveFiles(String folderPath) #

Returns: OfficeImageExportBatchSaveResult

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

folderPath String requiredposition: 0

public async Task<OfficeImageExportBatchSaveResult> SaveFilesAsync(String folderPath, CancellationToken cancellationToken = null)

Returns: Task<OfficeImageExportBatchSaveResult>

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

folderPath String requiredposition: 0
cancellationToken CancellationToken = null optionalposition: 1

public override String ToString() #

OfficeIMO.OneNote/Internal/OneStore/OneNotePackageStoreReader.cs:210

Returns: String

Inherited from Object

WithBackground 2 overloads

public OneNotePageImageBatchExportBuilder WithBackground(OfficeColor color) #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.cs:210

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

color OfficeColor requiredposition: 0

public OneNotePageImageBatchExportBuilder WithBackground(String color) #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.cs:279

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

color String requiredposition: 0

public OneNotePageImageBatchExportBuilder WithBatchLimits(Int32 maximumOutputCount, Int64 maximumTotalRasterPixels, Int64 maximumTotalEncodedBytes)

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.cs:484

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

maximumOutputCount Int32 requiredposition: 0
maximumTotalRasterPixels Int64 requiredposition: 1
maximumTotalEncodedBytes Int64 requiredposition: 2

public OneNotePageImageBatchExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

familyName String requiredposition: 0
data Byte[] requiredposition: 1
style OfficeFontStyle = Regular optionalposition: 2

public OneNotePageImageBatchExportBuilder WithFonts(OfficeFontFaceCollection fonts) #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.cs:693

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

fonts OfficeFontFaceCollection requiredposition: 0

public OneNotePageImageBatchExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.Lists.cs:12

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

imageCodec IOfficeRasterImageCodec requiredposition: 0

public OneNotePageImageBatchExportBuilder WithMaximumConcurrency(Int32 maximumDegreeOfParallelism) #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.cs:628

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

maximumDegreeOfParallelism Int32 requiredposition: 0

public OneNotePageImageBatchExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.cs:347

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

maximumPixels Int64 requiredposition: 0

public OneNotePageImageBatchExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.cs:207

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

configure Action<OfficeImageExportPolicy> requiredposition: 0

public OneNotePageImageBatchExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

progress IProgress<OfficeImageExportProgress> requiredposition: 0

public OneNotePageImageBatchExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.cs:331

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

configure Action<OfficeRasterEncodingOptions> requiredposition: 0

public OneNotePageImageBatchExportBuilder WithScale(Double scale) #

OfficeIMO.OneNote/Internal/Semantic/OneNoteSemanticMapper.cs:157

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

scale Double requiredposition: 0

public OneNotePageImageBatchExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #

Returns: OneNotePageImageBatchExportBuilder

Inherited from 0, Culture=neutral, PublicKeyToken=null]]

Parameters

provider IOfficeTextShapingProvider requiredposition: 0
language String = null optionalposition: 1