Click or drag to resize

PdfImgExtract Class

The PDF images extractor class
Inheritance Hierarchy
SystemObject
  ExpertPdfPdfImgExtract

Namespace: ExpertPdf
Assembly: eppdfimgextract (in eppdfimgextract.dll) Version: 10.0
Syntax
public class PdfImgExtract

The PdfImgExtract type exposes the following members.

Constructors
 NameDescription
Public methodPdfImgExtract The image extractor constructor
Top
Properties
 NameDescription
Public propertyDocumentInformation PDF document information. This property is populated after the requested operation (ExtractImages) is finished.
Public propertyEndPageNumber The page number where the images extraction will end. The default value is 0 which means that all the PDF document images will be extracted starting from the StartPageNumber page.
Public propertyExtractImageFormat The image format for the extracted images.
Public propertyExtractPath The path to the disk folder where the images will be extracted when the extractToFolder parameter of the ExtractImages() method is true.
Public propertyExtractPrefix The prefix for extracted images file name.
Public propertyLicenseKey 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 images extraction method. When this property is null, the converter will run in demo mode.
Public propertyMinimumHeight The minimum height in pixels of an extracted image: a shorter image is skipped (no ImageExtractedEvent, not saved, not returned). The default value is 0, which extracts the images of any height.
Public propertyMinimumWidth The minimum width in pixels of an extracted image: a narrower image is skipped (no ImageExtractedEvent, not saved, not returned). The default value is 0, which extracts the images of any width.
Public propertyPdfToolsFullPath Gets or sets the full path (including the file name) of the pdf tools engine helper file.
Public propertyPdfToolsTimeout Timeout in seconds for the current operation. Default value is 600 seconds.
Public propertySkipDuplicateImages When this property is true an image is extracted only the first time it is found: an image with the same size and the same pixels as an image extracted before (for example a logo repeated on every page) is skipped. The default value is false, which extracts every occurrence.
Public propertyStartPageNumber The page number from where the images extraction will start. The default value is 1 which means the images extraction will start from the first page.
Public propertyUserPassword 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
 NameDescription
Public methodExtractImages(Stream) Extracts the images from the specified PDF stream. An ImageExtractedEvent is raised immediately after the image was extracted. The event handler argument exposes the extracted Bitmap object and the number of the PDF page from where the image was extracted.
Public methodExtractImages(String) Extracts the images from the specified PDF file. An ImageExtractedEvent is raised immediately after the image was extracted. The event handler argument exposes the extracted Bitmap object and the number of the PDF page from where the image was extracted.
Public methodExtractImages(Stream, Boolean) Extracts the images from the specified PDF stream. An ImageExtractedEvent is raised immediately after the image was extracted. When the extractToFolder parameter is true, the extracted images will be saved in the ExtractPath folder in the format specified by ExtractImageFormat property. When the extractToFolder parameter is false the images will not be saved on the disk.
Public methodExtractImages(String, Boolean) Extracts the images from the specified PDF file. An ImageExtractedEvent is raised immediately after the image was extracted. When the extractToFolder parameter is true, the extracted images will be saved in the ExtractPath folder in the format specified by ExtractImageFormat property. When the extractToFolder parameter is false the images will not be saved on the disk.
Public methodExtractImagesToMemory(Stream) Extracts the images from the specified PDF stream into memory. The images are not saved on the disk.
Public methodExtractImagesToMemory(String) Extracts the images from the specified PDF file into memory. The images are not saved on the disk.
Public methodGetPageCount(Stream) Gets the number of pages in the specified PDF stream.
Public methodGetPageCount(String) Gets the number of pages in the specified PDF file.
Top
Events
 NameDescription
Public eventImageExtractedEvent The ImageExtracted event raised after an image was extracted. The event handler argument exposes the extracted Bitmap object and the number of the PDF page from where the image was extracted
Top
See Also