The PDF images extractor class
Inheritance HierarchySystemObject
ExpertPdf.AnywherePdfImgExtract
Namespace: ExpertPdf.AnywhereAssembly: ExpertPdf.Anywhere (in ExpertPdf.Anywhere.dll) Version: 22.0
Syntaxpublic class PdfImgExtract : IDisposable
Public Class PdfImgExtract
Implements IDisposable
The PdfImgExtract type exposes the following members.
Constructors
Properties| | Name | Description |
|---|
 | DocumentInformation |
PDF document information. This property is populated after the requested operation (ExtractImages) is finished.
|
 | EndPageNumber |
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.
|
 | ExtractImageFormat |
The image format for the extracted images.
|
 | ExtractPath |
The path to the disk folder where the images will be extracted when the extractToFolder parameter of the
ExtractImages() method is true.
|
 | ExtractPrefix |
The prefix for extracted images file name.
|
 | 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 images extraction method. When this property is null, the converter
will run in demo mode.
|
 | MinimumHeight |
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.
|
 | MinimumWidth |
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.
|
 | 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.
|
 | SkipDuplicateImages |
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.
|
 | StartPageNumber |
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.
|
 | 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.
|
 | Dispose |
Releases the PDF document read by the last call; the same as Close. Use the object in a using block.
|
 | ExtractImages(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 image and the number of the PDF page from where the image was extracted.
|
 | ExtractImages(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 image and the number of the PDF page from where the image was extracted.
|
 | ExtractImages(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.
|
 | ExtractImages(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.
|
 | ExtractImagesToMemory(Stream) |
Extracts the images from the specified PDF stream into memory. The images are not saved on the disk.
|
 | ExtractImagesToMemory(String) |
Extracts the images from the specified PDF file into memory. The images are not saved on the disk.
|
 | 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
Events| | Name | Description |
|---|
 | ImageExtractedEvent |
The ImageExtracted event raised after an image was extracted. The event handler argument
exposes the extracted image and the number of the PDF page from where the image was extracted
|
Top
See Also