API Reference
Class
OneNotePageImageExportBuilder
Fluent image export for one OneNote page.
Inheritance
- OfficeImageExportBuilder<OneNotePageImageExportBuilder, OneNotePageRenderingOptions>
- OneNotePageImageExportBuilder
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.ToImage
- Method OneNoteImageExportExtensions.ToImage
- Extension method OneNotePage.ToImage
- Extension method OneNotePage.ToImage
- Method OneNotePageImageExportBuilder.As
- Method OneNotePageImageExportBuilder.AsJpeg
- Method OneNotePageImageExportBuilder.AsPng
- Method OneNotePageImageExportBuilder.AsSvg
- Method OneNotePageImageExportBuilder.AsTiff
- Method OneNotePageImageExportBuilder.AsWebp
- Method OneNotePageImageExportBuilder.AtDpi
- Method OneNotePageImageExportBuilder.ForPreview
- Method OneNotePageImageExportBuilder.ForPrint
- Method OneNotePageImageExportBuilder.IncludeImages
- Method OneNotePageImageExportBuilder.IncludeInk
- Method OneNotePageImageExportBuilder.IncludeMath
- Method OneNotePageImageExportBuilder.IncludeTitle
- Method OneNotePageImageExportBuilder.OnFileConflict
- Method OneNotePageImageExportBuilder.OnRasterOverflow
- Method OneNotePageImageExportBuilder.WithBackground
- Method OneNotePageImageExportBuilder.WithBackground
- Method OneNotePageImageExportBuilder.WithFont
- Method OneNotePageImageExportBuilder.WithFonts
- Method OneNotePageImageExportBuilder.WithImageCodec
- Method OneNotePageImageExportBuilder.WithMaximumRasterPixels
- Method OneNotePageImageExportBuilder.WithPolicy
- Method OneNotePageImageExportBuilder.WithProgress
- Method OneNotePageImageExportBuilder.WithRasterEncoding
- Method OneNotePageImageExportBuilder.WithScale
- Method OneNotePageImageExportBuilder.WithTextShaping
Methods
public OneNotePageImageExportBuilder IncludeImages(Boolean include = true) #Returns:
OneNotePageImageExportBuilderIncludes or excludes embedded images and printout backgrounds.
Parameters
- include System.Boolean = true
public OneNotePageImageExportBuilder IncludeInk(Boolean include = true) #Returns:
OneNotePageImageExportBuilderIncludes or excludes native ink.
Parameters
- include System.Boolean = true
public OneNotePageImageExportBuilder IncludeMath(Boolean include = true) #Returns:
OneNotePageImageExportBuilderIncludes or excludes structured math typesetting.
Parameters
- include System.Boolean = true
public OneNotePageImageExportBuilder IncludeTitle(Boolean include = true) #Returns:
OneNotePageImageExportBuilderIncludes or excludes the page title.
Parameters
- include System.Boolean = true
Inherited Methods
public OneNotePageImageExportBuilder As(OfficeImageExportFormat format) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public OneNotePageImageExportBuilder AsJpeg() #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public OneNotePageImageExportBuilder AsPng() #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public OneNotePageImageExportBuilder AsSvg() #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public OneNotePageImageExportBuilder AsTiff() #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public OneNotePageImageExportBuilder AsWebp() #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public OneNotePageImageExportBuilder AtDpi(Double dpi) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Export 2 overloads
public OfficeImageExportResult Export() #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
public OfficeImageExportResult Export(CancellationToken cancellationToken) #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- cancellationToken CancellationToken
public async Task<OfficeImageExportResult> ExportAsync(CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- cancellationToken CancellationToken = null
public OneNotePageImageExportBuilder ForPreview() #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public OneNotePageImageExportBuilder ForPrint(Double dpi = 300) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public OneNotePageImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public OneNotePageImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- behavior OfficeRasterOverflowBehavior
Save 2 overloads
public OfficeImageExportResult Save(String path) #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- path String
public OfficeImageExportResult Save(Stream stream) #Returns:
OfficeImageExportResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- stream Stream
SaveAsync 2 overloads
public async Task<OfficeImageExportResult> SaveAsync(String path, CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- path String
- cancellationToken CancellationToken = null
public async Task<OfficeImageExportResult> SaveAsync(Stream stream, CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- stream Stream
- cancellationToken CancellationToken = null
WithBackground 2 overloads
public OneNotePageImageExportBuilder WithBackground(OfficeColor color) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public OneNotePageImageExportBuilder WithBackground(String color) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color String
public OneNotePageImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public OneNotePageImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public OneNotePageImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public OneNotePageImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public OneNotePageImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public OneNotePageImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public OneNotePageImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public OneNotePageImageExportBuilder WithScale(Double scale) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double
public OneNotePageImageExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #Returns:
OneNotePageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- provider IOfficeTextShapingProvider
- language String = null