ImageConvertOptions

ImageConvertOptions class

Options for conversion to Image file type.

public sealed class ImageConvertOptions : CommonConvertOptions<ImageFileType>, IUsePdfConvertOptions

Constructors

Name Description
ImageConvertOptions() Initializes new instance of ImageConvertOptions class.

Properties

Name Description
BackgroundColor { get; set; } Sets background color where supported by the source format
Brightness { get; set; } Adjusts image brightness.
CapResolutionToPageContent { get; set; } When set, caps the per-page PDF render resolution to the page native raster resolution so a page is never rendered at a higher DPI than its embedded image actually contains, and emits that page at its native (smaller) pixel dimensions and native DPI in the final output instead of re-inflating it to the requested DPI. Only image-dominated (scan) pages are affected; pages with text or vector content are never softened and are emitted at the requested DPI. Skipped when an explicit output Width or Height is set. The default is false (no capping; every page is rendered and emitted at the requested DPI).
Contrast { get; set; } Adjusts image contrast.
CropArea { get; set; } Crop raster image area after conversion
FlipMode { get; set; } Image flip mode.
Format { get; set; } The desired file type the input document should be converted to.
virtual Format { get; set; } Implements Format
Gamma { get; set; } Adjusts image gamma.
Grayscale { get; set; } Indicates whether to convert into grayscale image.
Height { get; set; } Desired image height after conversion.
HorizontalResolution { get; set; } Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.
JpegOptions { get; set; } Jpeg specific convert options.
MinResolution { get; set; } Per-axis lower bound applied to the capped render DPI when CapResolutionToPageContent is enabled. The capped DPI is never lowered below this value. The default is 0 (no floor).
PageNumber { get; set; } Implements PageNumber
Pages { get; set; } Implements Pages
PagesCount { get; set; } Implements PagesCount
PsdOptions { get; set; } Psd specific convert options.
RotateAngle { get; set; } Image rotation angle.
TiffOptions { get; set; } Tiff specific convert options.
UsePdf { get; set; } If true, the input firstly is converted to PDF and after that to desired format
VerticalResolution { get; set; } Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.
Watermark { get; set; } Implements Watermark
WebpOptions { get; set; } Webp specific convert options.
Width { get; set; } Desired image width after conversion.

Methods

Name Description
Clone() Clones current options instance.
override Equals(object) Determines whether two object instances are equal.
virtual Equals(ValueObject) Determines whether two object instances are equal.
override GetHashCode() Serves as the default hash function.

See Also