API Reference
Class
PdfPageImageExportBuilder
Fluent five-format image export for one PDF page.
Inheritance
- OfficeImageExportBuilder<PdfPageImageExportBuilder, PdfImageExportOptions>
- PdfPageImageExportBuilder
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 PdfImageExportExtensions.ToImage
- 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.ForPreview
- Method PdfPageImageExportBuilder.ForPrint
- Method PdfPageImageExportBuilder.OnFileConflict
- Method PdfPageImageExportBuilder.OnRasterOverflow
- Method PdfPageImageExportBuilder.WithBackground
- Method PdfPageImageExportBuilder.WithBackground
- Method PdfPageImageExportBuilder.WithFont
- Method PdfPageImageExportBuilder.WithFonts
- Method PdfPageImageExportBuilder.WithImageCodec
- Method PdfPageImageExportBuilder.WithMaximumRasterPixels
- Method PdfPageImageExportBuilder.WithPolicy
- Method PdfPageImageExportBuilder.WithProgress
- Method PdfPageImageExportBuilder.WithRasterEncoding
- Method PdfPageImageExportBuilder.WithScale
- Method PdfPageImageExportBuilder.WithTextShaping
- Extension method PdfReadPage.ToImage
- Extension method PdfReadPage.ToImage
Methods
public PdfPageImageExportBuilder AsThumbnail(Int32 maximumDimension) #Returns:
PdfPageImageExportBuilderFits the output within the requested maximum pixel width or height.
Parameters
- maximumDimension System.Int32
Inherited Methods
public PdfPageImageExportBuilder As(OfficeImageExportFormat format) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public PdfPageImageExportBuilder AsJpeg() #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public PdfPageImageExportBuilder AsPng() #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public PdfPageImageExportBuilder AsSvg() #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public PdfPageImageExportBuilder AsTiff() #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public PdfPageImageExportBuilder AsWebp() #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public PdfPageImageExportBuilder AtDpi(Double dpi) #Returns:
PdfPageImageExportBuilderInherited 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 PdfPageImageExportBuilder ForPreview() #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public PdfPageImageExportBuilder ForPrint(Double dpi = 300) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public PdfPageImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public PdfPageImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
PdfPageImageExportBuilderInherited 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 PdfPageImageExportBuilder WithBackground(OfficeColor color) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public PdfPageImageExportBuilder WithBackground(String color) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color String
public PdfPageImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public PdfPageImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public PdfPageImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public PdfPageImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public PdfPageImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public PdfPageImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public PdfPageImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public PdfPageImageExportBuilder WithScale(Double scale) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double
public PdfPageImageExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #Returns:
PdfPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- provider IOfficeTextShapingProvider
- language String = null