PdfToImageConverter Class |
The PDF to Image converter class
Inheritance HierarchySystemObject
ExpertPdf.AnywherePdfToImageConverter
Namespace: ExpertPdf.AnywhereAssembly: ExpertPdf.Anywhere (in ExpertPdf.Anywhere.dll) Version: 22.0
Syntaxpublic class PdfToImageConverter : IDisposable
Public Class PdfToImageConverter
Implements IDisposable
The PdfToImageConverter type exposes the following members.
Constructors
Properties| | Name | Description |
|---|
 | ColorSpace |
The color space of the generated images. Default value is RGB.
|
 | DocumentInformation |
PDF document information. This property is populated after a conversion or GetPageCount() is finished.
|
 | EndPageNumber |
The page number where the conversion to images will end. The default value is 0 which means that all the PDF document pages
will be converted to images starting from the StartPageNumber page.
|
 | ImagesFormat |
The image format for the generated images.
|
 | ImagesPath |
The path to the disk folder where the images will be saved when the method ConvertToImagesInFolder() is used.
|
 | ImagesPrefix |
The prefix for extracted images file name.
|
 | JpegQuality |
The quality of the JPEG images, from 0 (the smallest files) to 100 (the best quality). The default value is 91.
|
 | LicenseKey |
The license key string received after the product purchase or
a demo license key for the demo version of the converter. This property must be set
before calling the conversion to images method. When this property is null, the converter
will run in demo mode.
|
 | PdfToolsFullPath |
Gets or sets the full path of the PDF tools engine file, or of the folder that holds it. When it is not set, the
engine beside the application is used.
|
 | PdfToolsTimeout |
Timeout in seconds for the current operation. Default value is 600 seconds.
|
 | PngCompressionLevel |
The compression level of the PNG images, from 0 (no compression, the fastest) to 9 (the smallest files), or -1.
The default value is -1: the PNG images are saved as the renderer writes them.
|
 | Resolution |
The resolution of the generated images in DPI. Default value is 120.
|
 | StartPageNumber |
The page number from where the conversion to images will start. The default value is 1 which means the conversion to images
will start from the first page.
|
 | TiffCompression |
The compression of the TIFF images. The default value is PdfToImageTiffCompression.Lzw.
|
 | UserPassword |
The password to be used to open the PDF document for reading: the user password or the owner password of the
document. The default value is null which means that no password will be used to open the PDF document.
|
Top
Methods| | Name | Description |
|---|
 | Close |
Releases the PDF document read by the last call. The object can be used again afterwards.
|
 | ConvertPageToImage(Stream, Int32) |
Converts one page of the specified PDF stream to an image, at the resolution given by the Resolution property.
|
 | ConvertPageToImage(String, Int32) |
Converts one page of the specified PDF file to an image, at the resolution given by the Resolution property.
|
 | ConvertPageToImageBytes(Stream, Int32, ImageFormat) |
Converts one page of the specified PDF stream to an image file in memory, at the resolution given by the
Resolution property.
|
 | ConvertPageToImageBytes(String, Int32, ImageFormat) |
Converts one page of the specified PDF file to an image file in memory, at the resolution given by the
Resolution property.
|
 | ConvertToImages(Stream) |
Convert to images the PDF pages from the specified PDF stream.
|
 | ConvertToImages(String) |
Convert to images the PDF pages from the specified PDF file.
|
 | ConvertToImagesInFolder(Stream) |
Convert to images the PDF pages from the specified PDF stream. The images will be saved into the folder specified by
ImagesPath property, in the format specified by ImagesFormat property.
|
 | ConvertToImagesInFolder(String) |
Convert to images the PDF pages from the specified PDF file. The images will be saved into the folder specified by
ImagesPath property, in the format specified by ImagesFormat property.
|
 | ConvertToThumbnails(Stream, Int32, Int32) |
Converts the PDF pages from the specified PDF stream to thumbnails: images that fit in a box of the specified size,
keeping the aspect ratio of each page.
|
 | ConvertToThumbnails(String, Int32, Int32) |
Converts the PDF pages from the specified PDF file to thumbnails: images that fit in a box of the specified size,
keeping the aspect ratio of each page.
|
 | ConvertToTiff(Stream) |
Converts the PDF pages from the specified PDF stream to a multi-page (multi frame) TIFF image.
|
 | ConvertToTiff(String) |
Converts the PDF pages from the specified PDF file to a multi-page (multi frame) TIFF image.
|
 | ConvertToTiffInFolder(Stream) |
Converts the PDF pages from the specified PDF stream to a multi-page TIFF image saved into the folder
specified by the ImagesPath property, as <ImagesPrefix>.tiff.
|
 | ConvertToTiffInFolder(String) |
Converts the PDF pages from the specified PDF file to a multi-page TIFF image saved into the folder
specified by the ImagesPath property, as <ImagesPrefix>.tiff.
|
 | Dispose |
Releases the PDF document read by the last call; the same as Close. Use the object in a using block.
|
 | GetPageCount(Stream) |
Gets the number of pages in the specified PDF stream.
|
 | GetPageCount(String) |
Gets the number of pages in the specified PDF file.
|
Top
See Also