API Reference
Class
EpubImageExportBuilder
Fluent batch image export for EPUB chapters.
Inheritance
- OfficeImageExportBatchBuilder<EpubImageExportBuilder, EpubImageExportOptions>
- EpubImageExportBuilder
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 EpubImageExportBuilder.As
- Method EpubImageExportBuilder.AsJpeg
- Method EpubImageExportBuilder.AsPng
- Method EpubImageExportBuilder.AsSvg
- Method EpubImageExportBuilder.AsTiff
- Method EpubImageExportBuilder.AsWebp
- Method EpubImageExportBuilder.AtDpi
- Method EpubImageExportBuilder.ConfigureOptions
- Method EpubImageExportBuilder.Continuous
- Method EpubImageExportBuilder.FitWithin
- Method EpubImageExportBuilder.FitWithinHeight
- Method EpubImageExportBuilder.FitWithinWidth
- Method EpubImageExportBuilder.ForPreview
- Method EpubImageExportBuilder.ForPrint
- Method EpubImageExportBuilder.FromChapter
- Method EpubImageExportBuilder.OnFileConflict
- Method EpubImageExportBuilder.OnRasterOverflow
- Method EpubImageExportBuilder.Paged
- Method EpubImageExportBuilder.TakeChapters
- Method EpubImageExportBuilder.WithBackground
- Method EpubImageExportBuilder.WithBackground
- Method EpubImageExportBuilder.WithBatchLimits
- Method EpubImageExportBuilder.WithFont
- Method EpubImageExportBuilder.WithFonts
- Method EpubImageExportBuilder.WithImageCodec
- Method EpubImageExportBuilder.WithMaximumConcurrency
- Method EpubImageExportBuilder.WithMaximumRasterPixels
- Method EpubImageExportBuilder.WithoutSizeLimit
- Method EpubImageExportBuilder.WithPolicy
- Method EpubImageExportBuilder.WithProgress
- Method EpubImageExportBuilder.WithQuality
- Method EpubImageExportBuilder.WithRasterEncoding
- Method EpubImageExportBuilder.WithRenderTimeout
- Method EpubImageExportBuilder.WithScale
- Method EpubImageExportBuilder.WithTextShaping
- Method EpubImageExportExtensions.ToImages
Methods
public EpubImageExportBuilder Continuous() #Returns:
EpubImageExportBuilderUses one continuous image surface per chapter.
public EpubImageExportBuilder FromChapter(Int32 chapterIndex) #Returns:
EpubImageExportBuilderStarts at a zero-based chapter index.
Parameters
- chapterIndex System.Int32
public EpubImageExportBuilder Paged() #Returns:
EpubImageExportBuilderUses physical paged layout for each chapter.
public EpubImageExportBuilder TakeChapters(Int32 chapterCount) #Returns:
EpubImageExportBuilderLimits the number of chapters exported.
Parameters
- chapterCount System.Int32
Inherited Methods
public EpubImageExportBuilder As(OfficeImageExportFormat format) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public EpubImageExportBuilder AsJpeg() #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EpubImageExportBuilder AsPng() #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EpubImageExportBuilder AsSvg() #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EpubImageExportBuilder AsTiff() #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EpubImageExportBuilder AsWebp() #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EpubImageExportBuilder AtDpi(Double dpi) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
public EpubImageExportBuilder ConfigureOptions(Action<EpubImageExportOptions> configure) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<EpubImageExportOptions>
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 = default) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- cancellationToken CancellationToken = default
public Void ExportEach(OfficeImageExportConsumer consumer, CancellationToken cancellationToken = default) #Returns:
VoidInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- consumer OfficeImageExportConsumer
- cancellationToken CancellationToken = default
public async Task ExportEachAsync(OfficeImageExportAsyncConsumer consumer, CancellationToken cancellationToken = default) #Returns:
TaskInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- consumer OfficeImageExportAsyncConsumer
- cancellationToken CancellationToken = default
public EpubImageExportBuilder FitWithin(Int32 maximumWidth, Int32 maximumHeight) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
- maximumHeight Int32
public EpubImageExportBuilder FitWithinHeight(Int32 maximumHeight) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumHeight Int32
public EpubImageExportBuilder FitWithinWidth(Int32 maximumWidth) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
public EpubImageExportBuilder ForPreview() #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EpubImageExportBuilder ForPrint(Double dpi = 300) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public EpubImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public EpubImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
EpubImageExportBuilderInherited 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 = default) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
- cancellationToken CancellationToken = default
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 = default) #Returns:
Task<OfficeImageExportBatchSaveResult>Inherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- folderPath String
- cancellationToken CancellationToken = default
WithBackground 2 overloads
public EpubImageExportBuilder WithBackground(OfficeColor color) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public EpubImageExportBuilder WithBackground(String color) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color String
public EpubImageExportBuilder WithBatchLimits(Int32 maximumOutputCount, Int64 maximumTotalRasterPixels, Int64 maximumTotalEncodedBytes) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumOutputCount Int32
- maximumTotalRasterPixels Int64
- maximumTotalEncodedBytes Int64
public EpubImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public EpubImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public EpubImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public EpubImageExportBuilder WithMaximumConcurrency(Int32 maximumDegreeOfParallelism) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumDegreeOfParallelism Int32
public EpubImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public EpubImageExportBuilder WithoutSizeLimit() #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public EpubImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public EpubImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public EpubImageExportBuilder WithQuality(OfficeImageExportQuality quality) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- quality OfficeImageExportQuality
public EpubImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public EpubImageExportBuilder WithRenderTimeout(TimeSpan timeout) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- timeout TimeSpan
public EpubImageExportBuilder WithScale(Double scale) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double
public EpubImageExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #Returns:
EpubImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- provider IOfficeTextShapingProvider
- language String = null