API Reference

Class

EmailImageExportBatchBuilder

Edit on GitHub

Namespace OfficeIMO.Email

Assembly OfficeIMO.Email.Image

Source ../../../../_/OfficeIMO.Email.Image/EmailImageExportBuilder.cs:85

Base OfficeImageExportBatchBuilder<EmailImageExportBatchBuilder, EmailImageExportOptions>

Modifiers sealed

Fluent batch image export for every rendered email page.

Inheritance

OfficeImageExportBatchBuilder<EmailImageExportBatchBuilder, EmailImageExportOptions>
EmailImageExportBatchBuilder

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 EmailImageExportBatchBuilder.As
Method EmailImageExportBatchBuilder.AsJpeg
Method EmailImageExportBatchBuilder.AsPng
Method EmailImageExportBatchBuilder.AsSvg
Method EmailImageExportBatchBuilder.AsTiff
Method EmailImageExportBatchBuilder.AsWebp
Method EmailImageExportBatchBuilder.AtDpi
Method EmailImageExportBatchBuilder.ConfigureOptions
Method EmailImageExportBatchBuilder.Continuous
Method EmailImageExportBatchBuilder.FitWithin
Method EmailImageExportBatchBuilder.FitWithinHeight
Method EmailImageExportBatchBuilder.FitWithinWidth
Method EmailImageExportBatchBuilder.ForPreview
Method EmailImageExportBatchBuilder.ForPrint
Method EmailImageExportBatchBuilder.OnFileConflict
Method EmailImageExportBatchBuilder.OnRasterOverflow
Method EmailImageExportBatchBuilder.Paged
Method EmailImageExportBatchBuilder.WithBackground
Method EmailImageExportBatchBuilder.WithBackground
Method EmailImageExportBatchBuilder.WithBatchLimits
Method EmailImageExportBatchBuilder.WithFont
Method EmailImageExportBatchBuilder.WithFonts
Method EmailImageExportBatchBuilder.WithImageCodec
Method EmailImageExportBatchBuilder.WithMaximumConcurrency
Method EmailImageExportBatchBuilder.WithMaximumRasterPixels
Method EmailImageExportBatchBuilder.WithoutSizeLimit
Method EmailImageExportBatchBuilder.WithPolicy
Method EmailImageExportBatchBuilder.WithProgress
Method EmailImageExportBatchBuilder.WithQuality
Method EmailImageExportBatchBuilder.WithRasterEncoding
Method EmailImageExportBatchBuilder.WithRenderTimeout
Method EmailImageExportBatchBuilder.WithScale
Method EmailImageExportBatchBuilder.WithTextShaping
Method EmailImageExportBuilderExtensions.ToImages

Methods

public EmailImageExportBatchBuilder Continuous() #

../../../../_/OfficeIMO.Email.Image/EmailImageExportBuilder.cs:85

Returns: EmailImageExportBatchBuilder

Uses one continuous image surface for the message.

public EmailImageExportBatchBuilder Paged() #

../../../../_/OfficeIMO.Email.Image/EmailImageExportBuilder.cs:91

Returns: EmailImageExportBatchBuilder

Uses paged layout and exports every rendered page.

Inherited Methods

public EmailImageExportBatchBuilder As(OfficeImageExportFormat format) #

Returns: EmailImageExportBatchBuilder

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

Parameters

format OfficeImageExportFormat requiredposition: 0

public EmailImageExportBatchBuilder AsJpeg() #

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder AsPng() #

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder AsSvg() #

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder AsTiff() #

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder AsWebp() #

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder AtDpi(Double dpi) #

Returns: EmailImageExportBatchBuilder

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

Parameters

dpi Double requiredposition: 0

public EmailImageExportBatchBuilder ConfigureOptions(Action<EmailImageExportOptions> configure) #

Returns: EmailImageExportBatchBuilder

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

Parameters

configure Action<EmailImageExportOptions> requiredposition: 0

public override Boolean Equals(Object obj) #

Returns: Boolean

Inherited from Object

Parameters

obj Object requiredposition: 0

public IReadOnlyList<OfficeImageExportResult> Export() #

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 EmailImageExportBatchBuilder FitWithin(Int32 maximumWidth, Int32 maximumHeight) #

Returns: EmailImageExportBatchBuilder

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

Parameters

maximumWidth Int32 requiredposition: 0
maximumHeight Int32 requiredposition: 1

public EmailImageExportBatchBuilder FitWithinHeight(Int32 maximumHeight) #

Returns: EmailImageExportBatchBuilder

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

Parameters

maximumHeight Int32 requiredposition: 0

public EmailImageExportBatchBuilder FitWithinWidth(Int32 maximumWidth) #

Returns: EmailImageExportBatchBuilder

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

Parameters

maximumWidth Int32 requiredposition: 0

public EmailImageExportBatchBuilder ForPreview() #

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder ForPrint(Double dpi = 300) #

Returns: EmailImageExportBatchBuilder

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

Parameters

dpi Double = 300 optionalposition: 0

public override Int32 GetHashCode() #

Returns: Int32

Inherited from Object

public Type GetType() #

Returns: Type

Inherited from Object

public EmailImageExportBatchBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #

Returns: EmailImageExportBatchBuilder

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

Parameters

policy OfficeImageExportFileConflictPolicy requiredposition: 0

public EmailImageExportBatchBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #

Returns: EmailImageExportBatchBuilder

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() #

Returns: String

Inherited from Object

WithBackground 2 overloads

public EmailImageExportBatchBuilder WithBackground(OfficeColor color) #

Returns: EmailImageExportBatchBuilder

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

Parameters

color OfficeColor requiredposition: 0

public EmailImageExportBatchBuilder WithBackground(String color) #

Returns: EmailImageExportBatchBuilder

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

Parameters

color String requiredposition: 0

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

Returns: EmailImageExportBatchBuilder

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

Parameters

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

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

Returns: EmailImageExportBatchBuilder

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

Parameters

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

public EmailImageExportBatchBuilder WithFonts(OfficeFontFaceCollection fonts) #

Returns: EmailImageExportBatchBuilder

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

Parameters

fonts OfficeFontFaceCollection requiredposition: 0

public EmailImageExportBatchBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #

Returns: EmailImageExportBatchBuilder

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

Parameters

imageCodec IOfficeRasterImageCodec requiredposition: 0

public EmailImageExportBatchBuilder WithMaximumConcurrency(Int32 maximumDegreeOfParallelism) #

Returns: EmailImageExportBatchBuilder

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

Parameters

maximumDegreeOfParallelism Int32 requiredposition: 0

public EmailImageExportBatchBuilder WithMaximumRasterPixels(Int64 maximumPixels) #

Returns: EmailImageExportBatchBuilder

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

Parameters

maximumPixels Int64 requiredposition: 0

public EmailImageExportBatchBuilder WithoutSizeLimit() #

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #

Returns: EmailImageExportBatchBuilder

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

Parameters

configure Action<OfficeImageExportPolicy> requiredposition: 0

public EmailImageExportBatchBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #

Returns: EmailImageExportBatchBuilder

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

Parameters

progress IProgress<OfficeImageExportProgress> requiredposition: 0

public EmailImageExportBatchBuilder WithQuality(OfficeImageExportQuality quality) #

Returns: EmailImageExportBatchBuilder

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

Parameters

quality OfficeImageExportQuality requiredposition: 0

public EmailImageExportBatchBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #

Returns: EmailImageExportBatchBuilder

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

Parameters

configure Action<OfficeRasterEncodingOptions> requiredposition: 0

public EmailImageExportBatchBuilder WithRenderTimeout(TimeSpan timeout) #

Returns: EmailImageExportBatchBuilder

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

Parameters

timeout TimeSpan requiredposition: 0

public EmailImageExportBatchBuilder WithScale(Double scale) #

Returns: EmailImageExportBatchBuilder

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

Parameters

scale Double requiredposition: 0

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

Returns: EmailImageExportBatchBuilder

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

Parameters

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