API Reference

Class

HtmlPageImageExportBuilder

Edit on GitHub

Namespace OfficeIMO.Html

Assembly OfficeIMO.Html

Source revision 804a7612eee4 with working tree changes

Source HtmlImageExportBuilder.cs:23

Base OfficeImageExportBuilder<HtmlPageImageExportBuilder, HtmlRenderOptions>

Modifiers sealed

Fluent image export for one rendered HTML surface.

Inheritance

OfficeImageExportBuilder<HtmlPageImageExportBuilder, HtmlRenderOptions>
HtmlPageImageExportBuilder

Usage

Explore 33 API references to this type

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

Returned or exposed by 33

Extension method HtmlConversionDocument.ToImage
Method HtmlImageExportExtensions.ToImage
Method HtmlPageImageExportBuilder.As
Method HtmlPageImageExportBuilder.AsJpeg
Method HtmlPageImageExportBuilder.AsPng
Method HtmlPageImageExportBuilder.AsSvg
Method HtmlPageImageExportBuilder.AsTiff
Method HtmlPageImageExportBuilder.AsWebp
Method HtmlPageImageExportBuilder.AtDpi
Method HtmlPageImageExportBuilder.ConfigureOptions
Method HtmlPageImageExportBuilder.Continuous
Method HtmlPageImageExportBuilder.FitWithin
Method HtmlPageImageExportBuilder.FitWithinHeight
Method HtmlPageImageExportBuilder.FitWithinWidth
Method HtmlPageImageExportBuilder.ForPreview
Method HtmlPageImageExportBuilder.ForPrint
Method HtmlPageImageExportBuilder.OnFileConflict
Method HtmlPageImageExportBuilder.OnRasterOverflow
Method HtmlPageImageExportBuilder.Page
Method HtmlPageImageExportBuilder.Paged
Method HtmlPageImageExportBuilder.WithBackground
Method HtmlPageImageExportBuilder.WithFont
Method HtmlPageImageExportBuilder.WithFonts
Method HtmlPageImageExportBuilder.WithImageCodec
Method HtmlPageImageExportBuilder.WithMaximumRasterPixels
Method HtmlPageImageExportBuilder.WithoutSizeLimit
Method HtmlPageImageExportBuilder.WithPolicy
Method HtmlPageImageExportBuilder.WithProgress
Method HtmlPageImageExportBuilder.WithQuality
Method HtmlPageImageExportBuilder.WithRasterEncoding
Method HtmlPageImageExportBuilder.WithRenderTimeout
Method HtmlPageImageExportBuilder.WithScale
Method HtmlPageImageExportBuilder.WithTextShaping

Methods

public HtmlPageImageExportBuilder Continuous() #

HtmlImageExportBuilder.cs:30

Returns: HtmlPageImageExportBuilder

Uses continuous layout for the rendered surface.

public HtmlPageImageExportBuilder Page(Int32 pageIndex) #

HtmlImageExportBuilder.cs:23

Returns: HtmlPageImageExportBuilder

Selects the zero-based rendered page or continuous surface to export.

Parameters

pageIndex System.Int32 requiredposition: 0

public HtmlPageImageExportBuilder Paged(Int32 pageIndex = 0) #

HtmlImageExportBuilder.cs:37

Returns: HtmlPageImageExportBuilder

Uses paged layout and selects the requested zero-based page.

Parameters

pageIndex System.Int32 = 0 optionalposition: 0

Inherited Methods

public HtmlPageImageExportBuilder As(OfficeImageExportFormat format) #

Returns: HtmlPageImageExportBuilder

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

Parameters

format OfficeImageExportFormat requiredposition: 0

public HtmlPageImageExportBuilder AsJpeg() #

Returns: HtmlPageImageExportBuilder

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

public HtmlPageImageExportBuilder AsPng() #

Returns: HtmlPageImageExportBuilder

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

public HtmlPageImageExportBuilder AsSvg() #

Returns: HtmlPageImageExportBuilder

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

public HtmlPageImageExportBuilder AsTiff() #

Returns: HtmlPageImageExportBuilder

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

public HtmlPageImageExportBuilder AsWebp() #

Returns: HtmlPageImageExportBuilder

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

public HtmlPageImageExportBuilder AtDpi(Double dpi) #

Returns: HtmlPageImageExportBuilder

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

Parameters

dpi Double requiredposition: 0

public HtmlPageImageExportBuilder ConfigureOptions(Action<HtmlRenderOptions> configure) #

Returns: HtmlPageImageExportBuilder

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

Parameters

configure Action<HtmlRenderOptions> requiredposition: 0

public virtual Boolean Equals(Object? obj) #

Returns: Boolean

Inherited from Object

Parameters

obj Object? requiredposition: 0

Export 2 overloads

public OfficeImageExportResult Export() #

Returns: OfficeImageExportResult

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

public OfficeImageExportResult Export(CancellationToken cancellationToken) #

Returns: OfficeImageExportResult

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

Parameters

cancellationToken CancellationToken requiredposition: 0

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

Returns: Task<OfficeImageExportResult>

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

Parameters

cancellationToken CancellationToken = default optionalposition: 0

public HtmlPageImageExportBuilder FitWithin(Int32 maximumWidth, Int32 maximumHeight) #

Returns: HtmlPageImageExportBuilder

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

Parameters

maximumWidth Int32 requiredposition: 0
maximumHeight Int32 requiredposition: 1

public HtmlPageImageExportBuilder FitWithinHeight(Int32 maximumHeight) #

Returns: HtmlPageImageExportBuilder

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

Parameters

maximumHeight Int32 requiredposition: 0

public HtmlPageImageExportBuilder FitWithinWidth(Int32 maximumWidth) #

Returns: HtmlPageImageExportBuilder

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

Parameters

maximumWidth Int32 requiredposition: 0

public HtmlPageImageExportBuilder ForPreview() #

Returns: HtmlPageImageExportBuilder

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

public HtmlPageImageExportBuilder ForPrint(Double dpi = 300) #

Returns: HtmlPageImageExportBuilder

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

Parameters

dpi Double = 300 optionalposition: 0

public virtual Int32 GetHashCode() #

Returns: Int32

Inherited from Object

public Type GetType() #

Returns: Type

Inherited from Object

public HtmlPageImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #

Returns: HtmlPageImageExportBuilder

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

Parameters

policy OfficeImageExportFileConflictPolicy requiredposition: 0

public HtmlPageImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #

Returns: HtmlPageImageExportBuilder

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

Parameters

behavior OfficeRasterOverflowBehavior requiredposition: 0

Save 2 overloads

public OfficeImageExportResult Save(String path) #

Returns: OfficeImageExportResult

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

Parameters

path String requiredposition: 0

public OfficeImageExportResult Save(Stream stream) #

Returns: OfficeImageExportResult

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

Parameters

stream Stream requiredposition: 0

SaveAsync 2 overloads

public async Task<OfficeImageExportResult> SaveAsync(String path, CancellationToken cancellationToken = default) #

Returns: Task<OfficeImageExportResult>

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

Parameters

path String requiredposition: 0
cancellationToken CancellationToken = default optionalposition: 1

public async Task<OfficeImageExportResult> SaveAsync(Stream stream, CancellationToken cancellationToken = default) #

Returns: Task<OfficeImageExportResult>

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

Parameters

stream Stream requiredposition: 0
cancellationToken CancellationToken = default optionalposition: 1

public Byte[] ToBytes() #

Returns: Byte[]

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

public virtual String? ToString() #

Returns: String?

Inherited from Object

WithBackground 2 overloads

public HtmlPageImageExportBuilder WithBackground(OfficeColor color) #

Returns: HtmlPageImageExportBuilder

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

Parameters

color OfficeColor requiredposition: 0

public HtmlPageImageExportBuilder WithBackground(String color) #

Returns: HtmlPageImageExportBuilder

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

Parameters

color String requiredposition: 0

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

Returns: HtmlPageImageExportBuilder

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

Parameters

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

public HtmlPageImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #

Returns: HtmlPageImageExportBuilder

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

Parameters

fonts OfficeFontFaceCollection requiredposition: 0

public HtmlPageImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #

Returns: HtmlPageImageExportBuilder

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

Parameters

imageCodec IOfficeRasterImageCodec requiredposition: 0

public HtmlPageImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #

Returns: HtmlPageImageExportBuilder

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

Parameters

maximumPixels Int64 requiredposition: 0

public HtmlPageImageExportBuilder WithoutSizeLimit() #

Returns: HtmlPageImageExportBuilder

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

public HtmlPageImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #

Returns: HtmlPageImageExportBuilder

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

Parameters

configure Action<OfficeImageExportPolicy> requiredposition: 0

public HtmlPageImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #

Returns: HtmlPageImageExportBuilder

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

Parameters

progress IProgress<OfficeImageExportProgress> requiredposition: 0

public HtmlPageImageExportBuilder WithQuality(OfficeImageExportQuality quality) #

Returns: HtmlPageImageExportBuilder

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

Parameters

quality OfficeImageExportQuality requiredposition: 0

public HtmlPageImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #

Returns: HtmlPageImageExportBuilder

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

Parameters

configure Action<OfficeRasterEncodingOptions> requiredposition: 0

public HtmlPageImageExportBuilder WithRenderTimeout(TimeSpan timeout) #

Returns: HtmlPageImageExportBuilder

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

Parameters

timeout TimeSpan requiredposition: 0

public HtmlPageImageExportBuilder WithScale(Double scale) #

Returns: HtmlPageImageExportBuilder

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

Parameters

scale Double requiredposition: 0

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

Returns: HtmlPageImageExportBuilder

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

Parameters

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