WordImageExportOptions
OfficeIMO.Word
Options controlling dependency-free Word document image export.
Inheritance
- OfficeImageExportOptions
- WordImageExportOptions
Usage
Explore 11 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
- Method WordImageExportOptions.Clone
Accepted by parameters 10
- Method WordImageExportExtensions.CreateVisualSnapshot
- Method WordImageExportExtensions.CreateVisualSnapshots
- Method WordImageExportExtensions.ExportImage
- Method WordImageExportExtensions.ExportImages
- Method WordImageExportExtensions.SaveAsImage
- Method WordImageExportExtensions.SaveAsImageAsync
- Method WordImageExportExtensions.SaveAsImages
- Method WordImageExportExtensions.SaveAsImagesAsync
- Method WordImageExportExtensions.ToImage
- Method WordImageExportExtensions.ToImageAsync
Constructors
public WordImageExportOptions() #Methods
public WordImageExportOptions Clone() #Creates an independent options snapshot.
Returns
WordImageExportOptionsInherited Methods
public OfficeImageExportResult EnsureAccepted(OfficeImageExportResult result) #Parameters
- result OfficeImageExportResult
Returns
OfficeImageExportResultpublic double GetEffectiveScale(double logicalWidth, double logicalHeight) #Parameters
- logicalWidth double
- logicalHeight double
Returns
doubleProperties
public override double LogicalUnitsPerInch { get; } #Logical document units represented by one inch. Point-based adapters override with 72.
public WordPdfExportOptions LayoutOptions { get; set; } #Gets or sets the shared Word page-layout settings used by both PDF and image export. Image-export fonts and shaping settings overlay these settings before pagination.
public int PageIndex { get; set; } #Gets or sets the zero-based page index to render or the first page used by batch export.
public int? PageCount { get; set; } #Gets or sets the maximum number of pages returned by batch export. A null value exports from WordImageExportOptions.PageIndex through the laid-out end of the document. Single-page export ignores this value.
public PdfPageSelection? PageSelection { get; set; } #Gets or sets a caller-ordered one-based selection for batch image export and visual snapshots. When supplied, this overrides WordImageExportOptions.PageIndex and WordImageExportOptions.PageCount for batches. Single-page operations continue to use WordImageExportOptions.PageIndex.
Inherited Properties
public OfficeImageExportFormat Format { get; set; } #public OfficeImageExportFileConflictPolicy FileConflictPolicy { get; set; } #public bool FailOnLoss { get; set; } #public double Scale { get; set; } #public int? MaximumOutputWidth { get; set; } #public int? MaximumOutputHeight { get; set; } #public OfficeColor BackgroundColor { get; set; } #public OfficeRasterEncodingOptions RasterEncoding { get; set; } #public bool SvgTextAsPaths { get; set; } #public long MaximumRasterPixels { get; set; } #public OfficeRasterOverflowBehavior RasterOverflowBehavior { get; set; } #public IOfficeRasterImageCodec? ImageCodec { get; set; } #public double? TargetDpi { get; set; } #public OfficeFontFaceCollection Fonts { get; set; } #public IOfficeTextShapingProvider? TextShapingProvider { get; set; } #public string? TextShapingLanguage { get; set; } #public OfficeImageExportPolicy Policy { get; set; } #public IProgress<OfficeImageExportProgress>? Progress { get; set; } #public int MaximumOutputCount { get; set; } #public long MaximumTotalRasterPixels { get; set; } #public long MaximumTotalEncodedBytes { get; set; } #public TimeSpan RenderTimeout { get; set; } #public int MaximumDegreeOfParallelism { get; set; } #