API Reference
Class
WordDocumentPageImageExportBuilder
Fluent batch image export for Word document pages.
Inheritance
- OfficeImageExportBatchBuilder<WordDocumentPageImageExportBuilder, WordImageExportOptions>
- WordDocumentPageImageExportBuilder
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 WordDocument.ToImages
- Method WordDocument.ToImages
- Method WordDocumentPageImageExportBuilder.AllPages
- Method WordDocumentPageImageExportBuilder.As
- Method WordDocumentPageImageExportBuilder.AsJpeg
- Method WordDocumentPageImageExportBuilder.AsPng
- Method WordDocumentPageImageExportBuilder.AsSvg
- Method WordDocumentPageImageExportBuilder.AsTiff
- Method WordDocumentPageImageExportBuilder.AsWebp
- Method WordDocumentPageImageExportBuilder.AtDpi
- Method WordDocumentPageImageExportBuilder.ConfigureOptions
- Method WordDocumentPageImageExportBuilder.FitWithin
- Method WordDocumentPageImageExportBuilder.FitWithinHeight
- Method WordDocumentPageImageExportBuilder.FitWithinWidth
- Method WordDocumentPageImageExportBuilder.ForPreview
- Method WordDocumentPageImageExportBuilder.ForPrint
- Method WordDocumentPageImageExportBuilder.FromPage
- Method WordDocumentPageImageExportBuilder.IncludeContent
- Method WordDocumentPageImageExportBuilder.OnFileConflict
- Method WordDocumentPageImageExportBuilder.OnRasterOverflow
- Method WordDocumentPageImageExportBuilder.TakePages
- Method WordDocumentPageImageExportBuilder.WithBackground
- Method WordDocumentPageImageExportBuilder.WithBackground
- Method WordDocumentPageImageExportBuilder.WithBatchLimits
- Method WordDocumentPageImageExportBuilder.WithFont
- Method WordDocumentPageImageExportBuilder.WithFonts
- Method WordDocumentPageImageExportBuilder.WithImageCodec
- Method WordDocumentPageImageExportBuilder.WithMaximumConcurrency
- Method WordDocumentPageImageExportBuilder.WithMaximumRasterPixels
- Method WordDocumentPageImageExportBuilder.WithoutSizeLimit
- Method WordDocumentPageImageExportBuilder.WithPolicy
- Method WordDocumentPageImageExportBuilder.WithProgress
- Method WordDocumentPageImageExportBuilder.WithRasterEncoding
- Method WordDocumentPageImageExportBuilder.WithRenderTimeout
- Method WordDocumentPageImageExportBuilder.WithScale
- Method WordDocumentPageImageExportBuilder.WithTextShaping
Methods
public WordDocumentPageImageExportBuilder AllPages() #Returns:
WordDocumentPageImageExportBuilderExports every estimated page from the beginning of the document.
public WordDocumentPageImageExportBuilder FromPage(Int32 pageIndex) #Returns:
WordDocumentPageImageExportBuilderExports from the specified zero-based page index.
Parameters
- pageIndex System.Int32
public WordDocumentPageImageExportBuilder IncludeContent(Boolean include = true) #Returns:
WordDocumentPageImageExportBuilderIncludes or excludes document body content.
Parameters
- include System.Boolean = true
public WordDocumentPageImageExportBuilder TakePages(Int32 pageCount) #Returns:
WordDocumentPageImageExportBuilderLimits batch output to the requested number of pages.
Parameters
- pageCount System.Int32
Inherited Methods
public WordDocumentPageImageExportBuilder As(OfficeImageExportFormat format) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- format OfficeImageExportFormat
public WordDocumentPageImageExportBuilder AsJpeg() #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentPageImageExportBuilder AsPng() #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentPageImageExportBuilder AsSvg() #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentPageImageExportBuilder AsTiff() #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentPageImageExportBuilder AsWebp() #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentPageImageExportBuilder AtDpi(Double dpi) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double
public WordDocumentPageImageExportBuilder ConfigureOptions(Action<WordImageExportOptions> configure) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<WordImageExportOptions>
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 WordDocumentPageImageExportBuilder FitWithin(Int32 maximumWidth, Int32 maximumHeight) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
- maximumHeight Int32
public WordDocumentPageImageExportBuilder FitWithinHeight(Int32 maximumHeight) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumHeight Int32
public WordDocumentPageImageExportBuilder FitWithinWidth(Int32 maximumWidth) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumWidth Int32
public WordDocumentPageImageExportBuilder ForPreview() #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentPageImageExportBuilder ForPrint(Double dpi = 300) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- dpi Double = 300
public WordDocumentPageImageExportBuilder OnFileConflict(OfficeImageExportFileConflictPolicy policy) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- policy OfficeImageExportFileConflictPolicy
public WordDocumentPageImageExportBuilder OnRasterOverflow(OfficeRasterOverflowBehavior behavior) #Returns:
WordDocumentPageImageExportBuilderInherited 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 WordDocumentPageImageExportBuilder WithBackground(OfficeColor color) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public WordDocumentPageImageExportBuilder WithBackground(String color) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color String
public WordDocumentPageImageExportBuilder WithBatchLimits(Int32 maximumOutputCount, Int64 maximumTotalRasterPixels, Int64 maximumTotalEncodedBytes) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumOutputCount Int32
- maximumTotalRasterPixels Int64
- maximumTotalEncodedBytes Int64
public WordDocumentPageImageExportBuilder WithFont(String familyName, Byte[] data, OfficeFontStyle style = Regular) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- familyName String
- data Byte[]
- style OfficeFontStyle = Regular
public WordDocumentPageImageExportBuilder WithFonts(OfficeFontFaceCollection fonts) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- fonts OfficeFontFaceCollection
public WordDocumentPageImageExportBuilder WithImageCodec(IOfficeRasterImageCodec imageCodec) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- imageCodec IOfficeRasterImageCodec
public WordDocumentPageImageExportBuilder WithMaximumConcurrency(Int32 maximumDegreeOfParallelism) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumDegreeOfParallelism Int32
public WordDocumentPageImageExportBuilder WithMaximumRasterPixels(Int64 maximumPixels) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- maximumPixels Int64
public WordDocumentPageImageExportBuilder WithoutSizeLimit() #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentPageImageExportBuilder WithPolicy(Action<OfficeImageExportPolicy> configure) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeImageExportPolicy>
public WordDocumentPageImageExportBuilder WithProgress(IProgress<OfficeImageExportProgress> progress) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- progress IProgress<OfficeImageExportProgress>
public WordDocumentPageImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public WordDocumentPageImageExportBuilder WithRenderTimeout(TimeSpan timeout) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- timeout TimeSpan
public WordDocumentPageImageExportBuilder WithScale(Double scale) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double
public WordDocumentPageImageExportBuilder WithTextShaping(IOfficeTextShapingProvider provider, String language = null) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- provider IOfficeTextShapingProvider
- language String = null