API Reference
Class
PdfDocumentImageExportBuilder
Fluent five-format batch image export for PDF pages.
Inheritance
- OfficeImageExportBatchBuilder<PdfDocumentImageExportBuilder, PdfImageExportOptions>
- PdfDocumentImageExportBuilder
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 PdfDocument.ToImages
- Extension method PdfDocument.ToImages
- Extension method PdfDocumentConversionResult.ToImages
- Extension method PdfDocumentConversionResult.ToImages
- Method PdfDocumentImageExportBuilder.AllPages
- Method PdfDocumentImageExportBuilder.As
- Method PdfDocumentImageExportBuilder.AsJpeg
- Method PdfDocumentImageExportBuilder.AsPng
- Method PdfDocumentImageExportBuilder.AsSvg
- Method PdfDocumentImageExportBuilder.AsThumbnails
- Method PdfDocumentImageExportBuilder.AsTiff
- Method PdfDocumentImageExportBuilder.AsWebp
- Method PdfDocumentImageExportBuilder.AtDpi
- Method PdfDocumentImageExportBuilder.ForPreview
- Method PdfDocumentImageExportBuilder.ForPrint
- Method PdfDocumentImageExportBuilder.OnFileConflict
- Method PdfDocumentImageExportBuilder.OnRasterOverflow
- Method PdfDocumentImageExportBuilder.Pages
- Method PdfDocumentImageExportBuilder.Pages
- Method PdfDocumentImageExportBuilder.WithBackground
- Method PdfDocumentImageExportBuilder.WithBackground
- Method PdfDocumentImageExportBuilder.WithBatchLimits
- Method PdfDocumentImageExportBuilder.WithFont
- Method PdfDocumentImageExportBuilder.WithFonts
- Method PdfDocumentImageExportBuilder.WithImageCodec
- Method PdfDocumentImageExportBuilder.WithMaximumConcurrency
- Method PdfDocumentImageExportBuilder.WithMaximumPages
- Method PdfDocumentImageExportBuilder.WithMaximumRasterPixels
- Method PdfDocumentImageExportBuilder.WithPolicy
- Method PdfDocumentImageExportBuilder.WithProgress
- Method PdfDocumentImageExportBuilder.WithRasterEncoding
- Method PdfDocumentImageExportBuilder.WithScale
- Method PdfDocumentImageExportBuilder.WithTextShaping
- Method PdfImageExportExtensions.ToImages
- Method PdfImageExportExtensions.ToImages
- Method PdfImageExportExtensions.ToImages
- Method PdfImageExportExtensions.ToImages
- Method PdfImageExportExtensions.ToImages
- Method PdfImageExportExtensions.ToImages
- Extension method PdfReadDocument.ToImages
- Extension method PdfReadDocument.ToImages
Methods
public PdfDocumentImageExportBuilder AllPages() #Returns:
PdfDocumentImageExportBuilderExports all document pages in source order.
public PdfDocumentImageExportBuilder AsThumbnails(Int32 maximumDimension) #Returns:
PdfDocumentImageExportBuilderFits every output page within the requested maximum pixel width or height.
Parameters
- maximumDimension System.Int32
Pages 2 overloads
public PdfDocumentImageExportBuilder Pages(PdfPageSelection selection) #Returns:
PdfDocumentImageExportBuilderSelects caller-ordered one-based PDF pages.
Parameters
- selection OfficeIMO.Pdf.PdfPageSelection
public PdfDocumentImageExportBuilder Pages(String selector) #Returns:
PdfDocumentImageExportBuilderSelects document-relative pages such as 1-3,last.
Parameters
- selector System.String
public PdfDocumentImageExportBuilder WithMaximumPages(Int32 maximumPages) #Returns:
PdfDocumentImageExportBuilderLimits the number of selected pages accepted by one export.
Parameters
- maximumPages System.Int32
Inherited Methods
public PdfDocumentImageExportBuilder As(OfficeImageExportFormat format) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public PdfDocumentImageExportBuilder AsJpeg() #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public PdfDocumentImageExportBuilder AsPng() #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public PdfDocumentImageExportBuilder AsSvg() #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public PdfDocumentImageExportBuilder AsTiff() #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public PdfDocumentImageExportBuilder AsWebp() #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public PdfDocumentImageExportBuilder AtDpi(Double dpi) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public IReadOnlyList<OfficeImageExportResult> Export() #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
public async Task<IReadOnlyList<OfficeImageExportResult>> ExportAsync(CancellationToken cancellationToken = null) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- cancellationToken CancellationToken = null
public Void ExportEach(OfficeImageExportConsumer consumer, CancellationToken cancellationToken = null) #Returns:
VoidInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- consumer OfficeImageExportConsumer
- cancellationToken CancellationToken = null
public async Task ExportEachAsync(OfficeImageExportAsyncConsumer consumer, CancellationToken cancellationToken = null) #Returns:
TaskInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- consumer OfficeImageExportAsyncConsumer
- cancellationToken CancellationToken = null
public PdfDocumentImageExportBuilder ForPreview() #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public PdfDocumentImageExportBuilder ForPrint(Double dpi = 300) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public PdfDocumentImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public PdfDocumentImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- behavior OfficeRasterOverflowBehavior
public IReadOnlyList<OfficeImageExportResult> Save(String folderPath) #Returns:
IReadOnlyList<OfficeImageExportResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public async Task<IReadOnlyList<OfficeImageExportResult>> SaveAsync(String folderPath, CancellationToken cancellationToken = null) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
- cancellationToken CancellationToken = null
public OfficeImageExportBatchSaveResult SaveFiles(String folderPath) #Returns:
OfficeImageExportBatchSaveResultInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
public async Task<OfficeImageExportBatchSaveResult> SaveFilesAsync(String folderPath, CancellationToken cancellationToken = null) #Returns:
Task<OfficeImageExportBatchSaveResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
- cancellationToken CancellationToken = null
WithBackground 2 overloads
public PdfDocumentImageExportBuilder WithBackground(OfficeColor color) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public PdfDocumentImageExportBuilder WithBackground(String color) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color String
public PdfDocumentImageExportBuilder WithBatchLimits(Int32 maximumOutputCount, Int64 maximumTotalRasterPixels, Int64 maximumTotalEncodedBytes) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumOutputCount Int32
- maximumTotalRasterPixels Int64
- maximumTotalEncodedBytes Int64
public PdfDocumentImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public PdfDocumentImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public PdfDocumentImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public PdfDocumentImageExportBuilder WithMaximumConcurrency(Int32 maximumDegreeOfParallelism) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumDegreeOfParallelism Int32
public PdfDocumentImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public PdfDocumentImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public PdfDocumentImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public PdfDocumentImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public PdfDocumentImageExportBuilder WithScale(Double scale) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double
public PdfDocumentImageExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #Returns:
PdfDocumentImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- provider IOfficeTextShapingProvider
- language String = null