ImageSaveOptions Class
Represents a class which stores saving options for image files.
public sealed class ImageSaveOptions : SaveOptions
Public NotInheritable Class ImageSaveOptions
Inherits SaveOptions
- Inheritance:
- ImageSaveOptions
Constructors
ImageSaveOptions()
Initializes a new instance of the ImageSaveOptions class.
ImageSaveOptions(ImageSaveFormat)
Initializes a new instance of the ImageSaveOptions class for a specific image format.
public ImageSaveOptions(ImageSaveFormat imageFormat)
Public Sub New(imageFormat As ImageSaveFormat)
Parameters
imageFormat
- ImageSaveFormat
The image format.
Properties
DpiX
Gets or sets the horizontal dots per inch (dpi) of the image.
Default value is NaN, which means that component specific default value will be used (currently 300).
Property Value
The horizontal dots per inch (dpi) of the image; that is, the dots per inch (dpi) along the x-axis.
Exceptions
Value is not greater than 0.
DpiY
Gets or sets the vertical dots per inch (dpi) of the image.
Default value is NaN, which means that component specific default value will be used (currently 300).
Property Value
The vertical dots per inch (dpi) of the image; that is, the dots per inch (dpi) along the y-axis.
Exceptions
Value is not greater than 0.
Format
Gets or sets the image format.
Property Value
The image format.
Height
Gets or sets the image height in pixels.
Property Value
The image height in pixels.
Remarks
If both Width and Height are not specified, then image size will be equal to the slide size.
If only one of the Width or Height is specified, then the specified dimension will be respected and other dimension will be calculated so that original aspect ratio is maintained.
If both Width and Height are specified, then both specified dimensions will be respected (which may result in non-uniformly scaled image, if aspect ratio is not equal to the original one.
PageCount
Gets or sets the number of pages which should be saved to a multi-frame image.
If image format doesn't support multiple frames, this property is ignored.
Default value is 1.
To save all pages, set value to MaxValue.
Only Tagged Image File Format (TIFF) and Graphics Interchange Format (GIF) format images support multiple frames.
Property Value
The number of pages which should be saved to a multi-frame image.
PageNumber
Gets or sets the zero-based page number of the document's page which should be saved to an image.
Property Value
The zero-based page number of the document's page which should be saved to an image.
PixelFormat
Gets or sets a pixel format, which will be used for the image.
Property Value
The pixel format, which will be used for the image.
TiffCompression
Gets or sets compression schema, which will be used when exporting to Tagged Image File Format (TIFF).
public TiffCompression TiffCompression { get; set; }
Public Property TiffCompression As TiffCompression
Property Value
The compression schema, which will be used when exporting to Tagged Image File Format (TIFF).
Width
Gets or sets the image width in pixels.
Property Value
The image width in pixels.
Remarks
If both Width and Height are not specified, then image size will be equal to the slide size.
If only one of the Width or Height is specified, then the specified dimension will be respected and other dimension will be calculated so that original aspect ratio is maintained.
If both Width and Height are specified, then both specified dimensions will be respected (which may result in non-uniformly scaled image, if aspect ratio is not equal to the original one.
Inherited Properties
Image | Gets the default saving options for image file format. Image will be saved in Bmp format. (Inherited from SaveOptions) |
Gets the default saving options for Portable Document Format (PDF). (Inherited from SaveOptions) | |
Xps | Gets the default saving options for XML Paper Specification (XPS) format. (Inherited from SaveOptions) |