API Reference

Class

PdfPageImageExportBuilder

Edit on GitHub

Namespace OfficeIMO.Pdf

Assembly OfficeIMO.Pdf

Source revision 804a7612eee4 with working tree changes

Source PdfImageExportBuilder.cs:17

Base OfficeImageExportBuilder<PdfPageImageExportBuilder, PdfImageExportOptions>

Modifiers sealed

Fluent five-format image export for one PDF page.

Inheritance

OfficeImageExportBuilder<PdfPageImageExportBuilder, PdfImageExportOptions>
PdfPageImageExportBuilder

Usage

Explore 31 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 31

Method PdfImageExportExtensions.ToImage
Method PdfPageImageExportBuilder.As
Method PdfPageImageExportBuilder.AsJpeg
Method PdfPageImageExportBuilder.AsPng
Method PdfPageImageExportBuilder.AsSvg
Method PdfPageImageExportBuilder.AsThumbnail
Method PdfPageImageExportBuilder.AsTiff
Method PdfPageImageExportBuilder.AsWebp
Method PdfPageImageExportBuilder.AtDpi
Method PdfPageImageExportBuilder.ConfigureOptions
Method PdfPageImageExportBuilder.FitWithin
Method PdfPageImageExportBuilder.FitWithinHeight
Method PdfPageImageExportBuilder.FitWithinWidth
Method PdfPageImageExportBuilder.ForPreview
Method PdfPageImageExportBuilder.ForPrint
Method PdfPageImageExportBuilder.OnFileConflict
Method PdfPageImageExportBuilder.OnRasterOverflow
Method PdfPageImageExportBuilder.WithBackground
Method PdfPageImageExportBuilder.WithFont
Method PdfPageImageExportBuilder.WithFonts
Method PdfPageImageExportBuilder.WithImageCodec
Method PdfPageImageExportBuilder.WithMaximumRasterPixels
Method PdfPageImageExportBuilder.WithoutSizeLimit
Method PdfPageImageExportBuilder.WithPolicy
Method PdfPageImageExportBuilder.WithProgress
Method PdfPageImageExportBuilder.WithQuality
Method PdfPageImageExportBuilder.WithRasterEncoding
Method PdfPageImageExportBuilder.WithRenderTimeout
Method PdfPageImageExportBuilder.WithScale
Method PdfPageImageExportBuilder.WithTextShaping
Extension method PdfReadPage.ToImage

Methods

public PdfPageImageExportBuilder AsThumbnail(Int32 maximumDimension) #

PdfImageExportBuilder.cs:17

Returns: PdfPageImageExportBuilder

Fits the output within the requested maximum pixel width or height.

Parameters

maximumDimension System.Int32 requiredposition: 0

Inherited Methods

public PdfPageImageExportBuilder As(OfficeImageExportFormat format) #

Returns: PdfPageImageExportBuilder

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

Parameters

format OfficeImageExportFormat requiredposition: 0

public PdfPageImageExportBuilder AsJpeg() #

Returns: PdfPageImageExportBuilder

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

public PdfPageImageExportBuilder AsPng() #

Returns: PdfPageImageExportBuilder

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

public PdfPageImageExportBuilder AsSvg() #

Returns: PdfPageImageExportBuilder

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

public PdfPageImageExportBuilder AsTiff() #

Returns: PdfPageImageExportBuilder

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

public PdfPageImageExportBuilder AsWebp() #

Returns: PdfPageImageExportBuilder

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

public PdfPageImageExportBuilder AtDpi(Double dpi) #

Returns: PdfPageImageExportBuilder

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

Parameters

dpi Double requiredposition: 0

public PdfPageImageExportBuilder ConfigureOptions(Action<PdfImageExportOptions> configure) #

Returns: PdfPageImageExportBuilder

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

Parameters

configure Action<PdfImageExportOptions> 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 PdfPageImageExportBuilder FitWithin(Int32 maximumWidth, Int32 maximumHeight) #

Returns: PdfPageImageExportBuilder

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

Parameters

maximumWidth Int32 requiredposition: 0
maximumHeight Int32 requiredposition: 1

public PdfPageImageExportBuilder FitWithinHeight(Int32 maximumHeight) #

Returns: PdfPageImageExportBuilder

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

Parameters

maximumHeight Int32 requiredposition: 0

public PdfPageImageExportBuilder FitWithinWidth(Int32 maximumWidth) #

Returns: PdfPageImageExportBuilder

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

Parameters

maximumWidth Int32 requiredposition: 0

public PdfPageImageExportBuilder ForPreview() #

Returns: PdfPageImageExportBuilder

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

public PdfPageImageExportBuilder ForPrint(Double dpi = 300) #

Returns: PdfPageImageExportBuilder

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

Returns: PdfPageImageExportBuilder

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

Parameters

policy OfficeImageExportFileConflictPolicy requiredposition: 0

public PdfPageImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #

Returns: PdfPageImageExportBuilder

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

Returns: PdfPageImageExportBuilder

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

Parameters

color OfficeColor requiredposition: 0

public PdfPageImageExportBuilder WithBackground(String color) #

Returns: PdfPageImageExportBuilder

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

Parameters

color String requiredposition: 0

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

Returns: PdfPageImageExportBuilder

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

Parameters

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

public PdfPageImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #

Returns: PdfPageImageExportBuilder

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

Parameters

fonts OfficeFontFaceCollection requiredposition: 0

public PdfPageImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #

Returns: PdfPageImageExportBuilder

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

Parameters

imageCodec IOfficeRasterImageCodec requiredposition: 0

public PdfPageImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #

Returns: PdfPageImageExportBuilder

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

Parameters

maximumPixels Int64 requiredposition: 0

public PdfPageImageExportBuilder WithoutSizeLimit() #

Returns: PdfPageImageExportBuilder

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

public PdfPageImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #

Returns: PdfPageImageExportBuilder

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

Parameters

configure Action<OfficeImageExportPolicy> requiredposition: 0

public PdfPageImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #

Returns: PdfPageImageExportBuilder

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

Parameters

progress IProgress<OfficeImageExportProgress> requiredposition: 0

public PdfPageImageExportBuilder WithQuality(OfficeImageExportQuality quality) #

Returns: PdfPageImageExportBuilder

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

Parameters

quality OfficeImageExportQuality requiredposition: 0

public PdfPageImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #

Returns: PdfPageImageExportBuilder

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

Parameters

configure Action<OfficeRasterEncodingOptions> requiredposition: 0

public PdfPageImageExportBuilder WithRenderTimeout(TimeSpan timeout) #

Returns: PdfPageImageExportBuilder

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

Parameters

timeout TimeSpan requiredposition: 0

public PdfPageImageExportBuilder WithScale(Double scale) #

Returns: PdfPageImageExportBuilder

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

Parameters

scale Double requiredposition: 0

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

Returns: PdfPageImageExportBuilder

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

Parameters

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