API Reference
Class
HtmlPageImageExportBuilder
Fluent image export for one rendered HTML surface.
Inheritance
- OfficeImageExportBuilder<HtmlPageImageExportBuilder, HtmlRenderOptions>
- HtmlPageImageExportBuilder
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.ToImage
- Extension method HtmlConversionDocument.ToImage
- Method HtmlImageExportExtensions.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.Continuous
- Method HtmlPageImageExportBuilder.ForPreview
- Method HtmlPageImageExportBuilder.ForPrint
- Method HtmlPageImageExportBuilder.OnFileConflict
- Method HtmlPageImageExportBuilder.OnRasterOverflow
- Method HtmlPageImageExportBuilder.Page
- Method HtmlPageImageExportBuilder.Paged
- Method HtmlPageImageExportBuilder.WithBackground
- Method HtmlPageImageExportBuilder.WithBackground
- Method HtmlPageImageExportBuilder.WithFont
- Method HtmlPageImageExportBuilder.WithFonts
- Method HtmlPageImageExportBuilder.WithImageCodec
- Method HtmlPageImageExportBuilder.WithMaximumRasterPixels
- Method HtmlPageImageExportBuilder.WithPolicy
- Method HtmlPageImageExportBuilder.WithProgress
- Method HtmlPageImageExportBuilder.WithRasterEncoding
- Method HtmlPageImageExportBuilder.WithScale
- Method HtmlPageImageExportBuilder.WithTextShaping
Methods
public HtmlPageImageExportBuilder Continuous() #Returns:
HtmlPageImageExportBuilderUses continuous layout for the rendered surface.
public HtmlPageImageExportBuilder Page(Int32 pageIndex) #Returns:
HtmlPageImageExportBuilderSelects the zero-based rendered page or continuous surface to export.
Parameters
- pageIndex System.Int32
public HtmlPageImageExportBuilder Paged(Int32 pageIndex = 0) #Returns:
HtmlPageImageExportBuilderUses paged layout and selects the requested zero-based page.
Parameters
- pageIndex System.Int32 = 0
Inherited Methods
public HtmlPageImageExportBuilder As(OfficeImageExportFormat format) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public HtmlPageImageExportBuilder AsJpeg() #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public HtmlPageImageExportBuilder AsPng() #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public HtmlPageImageExportBuilder AsSvg() #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public HtmlPageImageExportBuilder AsTiff() #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public HtmlPageImageExportBuilder AsWebp() #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public HtmlPageImageExportBuilder AtDpi(Double dpi) #Returns:
HtmlPageImageExportBuilderInherited 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 HtmlPageImageExportBuilder ForPreview() #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public HtmlPageImageExportBuilder ForPrint(Double dpi = 300) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public HtmlPageImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public HtmlPageImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
HtmlPageImageExportBuilderInherited 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 HtmlPageImageExportBuilder WithBackground(OfficeColor color) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public HtmlPageImageExportBuilder WithBackground(String color) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color String
public HtmlPageImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public HtmlPageImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public HtmlPageImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public HtmlPageImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public HtmlPageImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public HtmlPageImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public HtmlPageImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public HtmlPageImageExportBuilder WithScale(Double scale) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double
public HtmlPageImageExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #Returns:
HtmlPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- provider IOfficeTextShapingProvider
- language String = null