API Reference
Class
WordImageExportOptions
Options controlling dependency-free Word document image export.
Inheritance
- OfficeImageExportOptions
- WordImageExportOptions
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 WordImageExportOptions.Clone
Accepted by parameters
- Method WordDocument.CreateVisualSnapshot
- Method WordDocument.CreateVisualSnapshots
- Method WordDocument.CreateVisualSnapshots
- Method WordDocument.ExportImage
- Method WordDocument.ExportImages
- Method WordDocument.ExportImages
- Method WordDocument.SaveAsImages
- Method WordDocument.SaveAsImages
- Method WordDocument.SaveAsImagesAsync
- Method WordDocument.SaveAsImagesAsync
- Method WordDocument.SaveAsJpeg
- Method WordDocument.SaveAsJpeg
- Method WordDocument.SaveAsJpegAsync
- Method WordDocument.SaveAsJpegAsync
- Method WordDocument.SaveAsPng
- Method WordDocument.SaveAsPng
- Method WordDocument.SaveAsPngAsync
- Method WordDocument.SaveAsPngAsync
- Method WordDocument.SaveAsSvg
- Method WordDocument.SaveAsSvg
- Method WordDocument.SaveAsSvgAsync
- Method WordDocument.SaveAsSvgAsync
- Method WordDocument.SaveAsTiff
- Method WordDocument.SaveAsTiff
- Method WordDocument.SaveAsTiffAsync
- Method WordDocument.SaveAsTiffAsync
- Method WordDocument.SaveAsWebp
- Method WordDocument.SaveAsWebp
- Method WordDocument.SaveAsWebpAsync
- Method WordDocument.SaveAsWebpAsync
- Method WordDocument.ToImage
- Method WordDocument.ToImages
- Method WordDocument.ToJpeg
- Method WordDocument.ToPng
- Method WordDocument.ToSvg
- Method WordDocument.ToTiff
- Method WordDocument.ToWebp
- Method WordDocumentImageExportBuilder.ConfigureOptions
- Method WordDocumentPageImageExportBuilder.ConfigureOptions
Constructors
public WordImageExportOptions() #Methods
public WordImageExportOptions Clone() #Returns:
WordImageExportOptionsCreates an independent options snapshot.
Inherited Methods
public OfficeImageExportResult EnsureAccepted(OfficeImageExportResult result) #Returns:
OfficeImageExportResultInherited from OfficeImageExportOptions
Parameters
- result OfficeImageExportResult
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public Double GetEffectiveScale(Double logicalWidth, Double logicalHeight) #Returns:
DoubleInherited from OfficeImageExportOptions
Parameters
- logicalWidth Double
- logicalHeight Double
Properties
public override Double LogicalUnitsPerInch { get; } #public Boolean IncludeDocumentContent { get; set; } #Gets or sets a value indicating whether document body content should be rendered when supported.
public Int32 PageIndex { get; set; } #Gets or sets the zero-based page index to render or the first page used by batch export.
public Nullable<Int32> PageCount { get; set; } #Gets or sets the maximum number of pages returned by batch export. A null value exports from PageIndex through the estimated end of the document. Single-page export ignores this value.
Inherited Properties
public Double Scale { get; set; } #Inherited from OfficeImageExportOptions
public Nullable<Int32> MaximumOutputWidth { get; set; } #Inherited from OfficeImageExportOptions
public Nullable<Int32> MaximumOutputHeight { get; set; } #Inherited from OfficeImageExportOptions
public OfficeColor BackgroundColor { get; set; } #Inherited from OfficeImageExportOptions
public OfficeRasterEncodingOptions RasterEncoding { get; set; } #Inherited from OfficeImageExportOptions
public Int64 MaximumRasterPixels { get; set; } #Inherited from OfficeImageExportOptions
public OfficeRasterOverflowBehavior RasterOverflowBehavior { get; set; } #Inherited from OfficeImageExportOptions
public IOfficeRasterImageCodec ImageCodec { get; set; } #Inherited from OfficeImageExportOptions
public Nullable<Double> TargetDpi { get; set; } #Inherited from OfficeImageExportOptions
public OfficeFontFaceCollection Fonts { get; set; } #Inherited from OfficeImageExportOptions
public IOfficeTextShapingProvider TextShapingProvider { get; set; } #Inherited from OfficeImageExportOptions
public String TextShapingLanguage { get; set; } #Inherited from OfficeImageExportOptions
public OfficeImageExportPolicy Policy { get; set; } #Inherited from OfficeImageExportOptions
public IProgress<OfficeImageExportProgress> Progress { get; set; } #Inherited from OfficeImageExportOptions
public Int32 MaximumOutputCount { get; set; } #Inherited from OfficeImageExportOptions
public Int64 MaximumTotalRasterPixels { get; set; } #Inherited from OfficeImageExportOptions
public Int64 MaximumTotalEncodedBytes { get; set; } #Inherited from OfficeImageExportOptions
public TimeSpan RenderTimeout { get; set; } #Inherited from OfficeImageExportOptions
public Int32 MaximumDegreeOfParallelism { get; set; } #Inherited from OfficeImageExportOptions