API Reference

Class

HtmlPageImageBatchExportBuilder

Edit on GitHub

Namespace OfficeIMO.Html

Assembly OfficeIMO.Html

Source OfficeIMO.Html/Rendering/HtmlImageExportBuilder.cs:73

Base OfficeImageExportBatchBuilder<HtmlPageImageBatchExportBuilder, HtmlRenderOptions>

Modifiers sealed

Fluent batch image export for all rendered HTML pages.

Inheritance

OfficeImageExportBatchBuilder<HtmlPageImageBatchExportBuilder, HtmlRenderOptions>
HtmlPageImageBatchExportBuilder

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

Extension method HtmlConversionDocument.ToImages
Extension method HtmlConversionDocument.ToImages
Method HtmlImageExportExtensions.ToImages
Method HtmlImageExportExtensions.ToImages
Method HtmlPageImageBatchExportBuilder.As
Method HtmlPageImageBatchExportBuilder.AsJpeg
Method HtmlPageImageBatchExportBuilder.AsPng
Method HtmlPageImageBatchExportBuilder.AsSvg
Method HtmlPageImageBatchExportBuilder.AsTiff
Method HtmlPageImageBatchExportBuilder.AsWebp
Method HtmlPageImageBatchExportBuilder.AtDpi
Method HtmlPageImageBatchExportBuilder.Continuous
Method HtmlPageImageBatchExportBuilder.ForPreview
Method HtmlPageImageBatchExportBuilder.ForPrint
Method HtmlPageImageBatchExportBuilder.OnFileConflict
Method HtmlPageImageBatchExportBuilder.OnRasterOverflow
Method HtmlPageImageBatchExportBuilder.Paged
Method HtmlPageImageBatchExportBuilder.WithBackground
Method HtmlPageImageBatchExportBuilder.WithBackground
Method HtmlPageImageBatchExportBuilder.WithBatchLimits
Method HtmlPageImageBatchExportBuilder.WithFont
Method HtmlPageImageBatchExportBuilder.WithFonts
Method HtmlPageImageBatchExportBuilder.WithImageCodec
Method HtmlPageImageBatchExportBuilder.WithMaximumConcurrency
Method HtmlPageImageBatchExportBuilder.WithMaximumRasterPixels
Method HtmlPageImageBatchExportBuilder.WithPolicy
Method HtmlPageImageBatchExportBuilder.WithProgress
Method HtmlPageImageBatchExportBuilder.WithRasterEncoding
Method HtmlPageImageBatchExportBuilder.WithScale
Method HtmlPageImageBatchExportBuilder.WithTextShaping

Methods

public HtmlPageImageBatchExportBuilder Continuous() #

OfficeIMO.Html/Rendering/HtmlImageExportBuilder.cs:73

Returns: HtmlPageImageBatchExportBuilder

Uses continuous layout, which produces one rendered surface.

public HtmlPageImageBatchExportBuilder Paged() #

OfficeIMO.Html/Rendering/HtmlImageExportBuilder.cs:79

Returns: HtmlPageImageBatchExportBuilder

Uses paged layout and exports every rendered page.

Inherited Methods

public HtmlPageImageBatchExportBuilder As(OfficeImageExportFormat format) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:14

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

format OfficeImageExportFormat requiredposition: 0

public HtmlPageImageBatchExportBuilder AsJpeg() #

OfficeIMO.Html/Rendering/HtmlRenderOptions.cs:188

Returns: HtmlPageImageBatchExportBuilder

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

public HtmlPageImageBatchExportBuilder AsPng() #

OfficeIMO.Html/Rendering/HtmlRenderOptions.cs:186

Returns: HtmlPageImageBatchExportBuilder

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

public HtmlPageImageBatchExportBuilder AsSvg() #

OfficeIMO.Html/Rendering/HtmlRenderOptions.cs:188

Returns: HtmlPageImageBatchExportBuilder

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

public HtmlPageImageBatchExportBuilder AsTiff() #

OfficeIMO.Html/Rendering/HtmlRenderOptions.cs:191

Returns: HtmlPageImageBatchExportBuilder

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

public HtmlPageImageBatchExportBuilder AsWebp() #

OfficeIMO.Html/Rendering/HtmlRenderOptions.cs:285

Returns: HtmlPageImageBatchExportBuilder

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

public HtmlPageImageBatchExportBuilder AtDpi(Double dpi) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:40

Returns: HtmlPageImageBatchExportBuilder

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

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:274

Returns: HtmlPageImageBatchExportBuilder

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

public HtmlPageImageBatchExportBuilder ForPrint(Double dpi = 300) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:289

Returns: HtmlPageImageBatchExportBuilder

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 HtmlPageImageBatchExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:259

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

policy OfficeImageExportFileConflictPolicy requiredposition: 0

public HtmlPageImageBatchExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:62

Returns: HtmlPageImageBatchExportBuilder

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 HtmlPageImageBatchExportBuilder WithBackground(OfficeColor color) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:43

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

color OfficeColor requiredposition: 0

public HtmlPageImageBatchExportBuilder WithBackground(String color) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:46

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

color String requiredposition: 0

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

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:55

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

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

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

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:93

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

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

public HtmlPageImageBatchExportBuilder WithFonts(OfficeFontFaceCollection fonts) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:146

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

fonts OfficeFontFaceCollection requiredposition: 0

public HtmlPageImageBatchExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

imageCodec IOfficeRasterImageCodec requiredposition: 0

public HtmlPageImageBatchExportBuilder WithMaximumConcurrency(Int32 maximumDegreeOfParallelism) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:58

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

maximumDegreeOfParallelism Int32 requiredposition: 0

public HtmlPageImageBatchExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:52

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

maximumPixels Int64 requiredposition: 0

public HtmlPageImageBatchExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:214

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

configure Action<OfficeImageExportPolicy> requiredposition: 0

public HtmlPageImageBatchExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:248

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

progress IProgress<OfficeImageExportProgress> requiredposition: 0

public HtmlPageImageBatchExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:49

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

configure Action<OfficeRasterEncodingOptions> requiredposition: 0

public HtmlPageImageBatchExportBuilder WithScale(Double scale) #

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:37

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

scale Double requiredposition: 0

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

OfficeIMO.Html/Rendering/HtmlRenderPage.cs:196

Returns: HtmlPageImageBatchExportBuilder

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

Parameters

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