API Reference

Class

EmailImageExportBatchBuilder

Edit on GitHub

Namespace OfficeIMO.Html

Assembly OfficeIMO.Html

Source OfficeIMO.Html/Email/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.Continuous
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.WithPolicy
Method EmailImageExportBatchBuilder.WithProgress
Method EmailImageExportBatchBuilder.WithRasterEncoding
Method EmailImageExportBatchBuilder.WithScale
Method EmailImageExportBatchBuilder.WithTextShaping
Method EmailImageExportBuilderExtensions.ToImages

Methods

public EmailImageExportBatchBuilder Continuous() #

OfficeIMO.Html/Email/EmailImageExportBuilder.cs:85

Returns: EmailImageExportBatchBuilder

Uses one continuous image surface for the message.

public EmailImageExportBatchBuilder Paged() #

OfficeIMO.Html/Email/EmailImageExportBuilder.cs:91

Returns: EmailImageExportBatchBuilder

Uses paged layout and exports every rendered page.

Inherited Methods

public EmailImageExportBatchBuilder As(OfficeImageExportFormat format) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:14

Returns: EmailImageExportBatchBuilder

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

Parameters

format OfficeImageExportFormat requiredposition: 0

public EmailImageExportBatchBuilder AsJpeg() #

OfficeIMO.Html/Rendering/HtmlRenderOptions.cs:188

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder AsPng() #

OfficeIMO.Html/Rendering/HtmlRenderOptions.cs:186

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder AsSvg() #

OfficeIMO.Html/Rendering/HtmlRenderOptions.cs:188

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder AsTiff() #

OfficeIMO.Html/Rendering/HtmlRenderOptions.cs:191

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder AsWebp() #

OfficeIMO.Html/Rendering/HtmlRenderOptions.cs:285

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder AtDpi(Double dpi) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:40

Returns: EmailImageExportBatchBuilder

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

Parameters

dpi Double requiredposition: 0

public override Boolean Equals(Object obj) #

OfficeIMO.Html/Rendering/HtmlRenderLayoutEngine.Positioning.OutOfFlow.cs:6

Returns: Boolean

Inherited from Object

Parameters

obj Object requiredposition: 0

public IReadOnlyList<OfficeImageExportResult> Export() #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:304

Returns: IReadOnlyList<OfficeImageExportResult>

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

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

OfficeIMO.Html/Rendering/HtmlRenderPathClipGroup.cs:21

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

OfficeIMO.Html/Rendering/HtmlRenderPathClipGroup.cs:39

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

OfficeIMO.Html/Rendering/HtmlRenderPathClipGroup.cs:42

Returns: Task

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

Parameters

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

public EmailImageExportBatchBuilder ForPreview() #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:274

Returns: EmailImageExportBatchBuilder

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

public EmailImageExportBatchBuilder ForPrint(Double dpi = 300) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:289

Returns: EmailImageExportBatchBuilder

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

Parameters

dpi Double = 300 optionalposition: 0

public override Int32 GetHashCode() #

OfficeIMO.Html/Rendering/HtmlRenderLayoutEngine.Positioning.OutOfFlow.cs:60

Returns: Int32

Inherited from Object

public Type GetType() #

OfficeIMO.Html/Rendering/HtmlRenderLayoutEngine.Positioning.Inline.cs:66

Returns: Type

Inherited from Object

public EmailImageExportBatchBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:259

Returns: EmailImageExportBatchBuilder

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

Parameters

policy OfficeImageExportFileConflictPolicy requiredposition: 0

public EmailImageExportBatchBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:62

Returns: EmailImageExportBatchBuilder

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

Parameters

behavior OfficeRasterOverflowBehavior requiredposition: 0

public IReadOnlyList<OfficeImageExportResult> Save(String folderPath) #

OfficeIMO.Html/Rendering/HtmlRenderPathClipGroup.cs:45

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)

OfficeIMO.Html/Rendering/HtmlRenderPathClipGroup.cs:51

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

OfficeIMO.Html/Rendering/HtmlRenderPathClipGroup.cs:48

Returns: OfficeImageExportBatchSaveResult

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

Parameters

folderPath String requiredposition: 0

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

OfficeIMO.Html/Rendering/HtmlRenderPathClipGroup.cs:61

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.Html/Rendering/HtmlRenderLayoutEngine.Positioning.Inline.cs:150

Returns: String

Inherited from Object

WithBackground 2 overloads

public EmailImageExportBatchBuilder WithBackground(OfficeColor color) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:43

Returns: EmailImageExportBatchBuilder

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

Parameters

color OfficeColor requiredposition: 0

public EmailImageExportBatchBuilder WithBackground(String color) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:46

Returns: EmailImageExportBatchBuilder

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

Parameters

color String requiredposition: 0

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

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:55

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

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:93

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

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:146

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

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:58

Returns: EmailImageExportBatchBuilder

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

Parameters

maximumDegreeOfParallelism Int32 requiredposition: 0

public EmailImageExportBatchBuilder WithMaximumRasterPixels(Int64 maximumPixels) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:52

Returns: EmailImageExportBatchBuilder

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

Parameters

maximumPixels Int64 requiredposition: 0

public EmailImageExportBatchBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:214

Returns: EmailImageExportBatchBuilder

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

Parameters

configure Action<OfficeImageExportPolicy> requiredposition: 0

public EmailImageExportBatchBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:248

Returns: EmailImageExportBatchBuilder

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

Parameters

progress IProgress<OfficeImageExportProgress> requiredposition: 0

public EmailImageExportBatchBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:49

Returns: EmailImageExportBatchBuilder

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

Parameters

configure Action<OfficeRasterEncodingOptions> requiredposition: 0

public EmailImageExportBatchBuilder WithScale(Double scale) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:37

Returns: EmailImageExportBatchBuilder

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

Parameters

scale Double requiredposition: 0

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

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:196

Returns: EmailImageExportBatchBuilder

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

Parameters

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