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 WordDocumentPageImageExportBuilder.AllPages
- Method WordDocumentPageImageExportBuilder.As
- Method WordDocumentPageImageExportBuilder.AsJpeg
- Method WordDocumentPageImageExportBuilder.AsPng
- Method WordDocumentPageImageExportBuilder.AsSvg
- Method WordDocumentPageImageExportBuilder.AsTiff
- Method WordDocumentPageImageExportBuilder.AsWebp
- Method WordDocumentPageImageExportBuilder.ForHighResolution
- Method WordDocumentPageImageExportBuilder.ForPreview
- Method WordDocumentPageImageExportBuilder.FromPage
- Method WordDocumentPageImageExportBuilder.IncludeContent
- Method WordDocumentPageImageExportBuilder.TakePages
- Method WordDocumentPageImageExportBuilder.WithBackground
- Method WordDocumentPageImageExportBuilder.WithRasterEncoding
- Method WordDocumentPageImageExportBuilder.WithScale
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 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 WordDocumentPageImageExportBuilder ForHighResolution() #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
public WordDocumentPageImageExportBuilder ForPreview() #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
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 WordDocumentPageImageExportBuilder WithBackground(String color) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- color OfficeColor
public WordDocumentPageImageExportBuilder WithRasterEncoding(Action<OfficeRasterEncodingOptions> configure) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<OfficeRasterEncodingOptions>
public WordDocumentPageImageExportBuilder WithScale(Double scale) #Returns:
WordDocumentPageImageExportBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Double