ImageExtractor Class
Free Trial Web API version Licensing Request A Quote
HAVE QUESTIONS OR NEED HELP?SUBMIT THE SUPPORT REQUEST FORM or write email toSUPPORT@BYTESCOUT.COM
Extracts images from PDF document.
Inheritance Hierarchy
Bytescout.PDFExtractorBaseExtractor
Bytescout.PDFExtractorImageExtractor
Namespace:Bytescout.PDFExtractor
Assembly: Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 13.4.0.4760-master
Syntax
The ImageExtractor type exposes the following members.
Constructors
Name | Description | |
---|---|---|
ImageExtractor | Initializes a new instance of the ImageExtractor class. | |
ImageExtractor(String, String) | Initializes a new instance of the ImageExtractor class. |
Properties
Name | Description | |
---|---|---|
CheckPermissions | Defines whether to respect permissions set by document owner. If True, extractor throws exception when the extraction is prohibited. IMPORTANT: THIS OPTION HAVE TO BE ENABLED AND SET TO "TRUE" TO RESPECT OWNERS OF PDF DOCUMENTS. IF YOU SET IT TO FALSE TO IGNORE PERMISSIONS WHICH ARE SET IN PDF DOCUMENT THEN YOU ARE SOLELY LIABLE FOR THIS ACTION AND ANY COPYRIGHT OR OTHER VIOLATIONS AT YOUR OWN RISK. BYTESCOUT IS NOT LIABLE FOR ANY DAMAGES, LOSSES, COPYRIGHT INFRINGEMENTS OR ANY OTHER CONSEQUENCES CAUSED BY IGNORING PERMISSIONS OF PDF DOCUMENT. BY CHANGING THIS OPTION YOU ARE CONFIRMING YOU ARE UNDERSTANDING ALL WRITTEN ABOVE AND DOING IT AT YOUR OWN RISK. (Inherited from BaseExtractor.) | |
ComHelpers | Set of utility functions and properties to use from COM/ActiveX. (Inherited from BaseExtractor.) | |
ContentType | Returns content type of PDF document: normal document, portfolio or XFA form. To extract files from PDF portfolio use AttachmentExtractor class. To extract XFA form content use XFAFormExtractor class. (Inherited from BaseExtractor.) | |
EmbeddedFileCount | Obsolete. Property is disabled to speed up the document loading. Use AttachmentExtractor to work with attachments. (Inherited from BaseExtractor.) | |
Encrypted | Gets whether the document is encrypted. (Inherited from BaseExtractor.) | |
ExtractionArea | Sets the extraction area by coordinates and dimensions (left, top, width, height). (Inherited from BaseExtractor.) | |
ExtractionAreaRect | Sets the extraction area by rectangle. (Inherited from BaseExtractor.) | |
ExtractionAreaUsageMode | Gets or sets how to use the ExtractionArea: whether to extract any object intersecting with the area or only objects completely located inside the area. (Inherited from BaseExtractor.) | |
ExtractRawImages | Controls if we need to enable extraction of raw images (preserving the original dimensions of raw image saved inside PDF). True causes to extract images with their original dimensions. False causes to extract images rescaled according to scaling and skews defined for rendering (so image extractor provides images similar to what you see). | |
IsDocumentLoaded | Get the document loaded state. (Inherited from BaseExtractor.) | |
LicenseInfo | Gets license information. (Inherited from BaseExtractor.) | |
PageDataCaching | Controls page data caching behavior. (Inherited from BaseExtractor.) | |
Password | PDF document password. (Inherited from BaseExtractor.) | |
Profiles | Comma-separated list of profiles to apply to the extractor. Profiles must be previously loaded. (Inherited from BaseExtractor.) | |
RegistrationKey | Registration key. (Inherited from BaseExtractor.) | |
RegistrationName | Registration name. (Inherited from BaseExtractor.) | |
Version | Gets the component version number. (Inherited from BaseExtractor.) |
Methods
Name | Description | |
---|---|---|
CreateProfile(String, Boolean, Boolean, Boolean) | Creates JSON profile will all extractor properties with current values. (Inherited from BaseExtractor.) | |
CreateProfile(String, String, Boolean, Boolean, Boolean) | Creates JSON profile will all extractor properties with current values. (Inherited from BaseExtractor.) | |
Dispose | Releases the unmanaged resources used by the instance and optionally releases the managed resources. (Inherited from BaseExtractor.) | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
FireParsingError | (Inherited from BaseExtractor.) | |
FireProgressChanged | (Inherited from BaseExtractor.) | |
GetCurrentImageAsArrayOfBytes | Returns current image as array of bytes in BMP format. | |
GetCurrentImageAsArrayOfBytes(ImageFormat) | Returns current image as array of bytes in specified format. | |
GetCurrentImageAsVariant | Returns current image in PNG format as array of bytes. This is COM/ActiveX-compatible version of the method SaveCurrentImageToStream(Stream) for in-memory processing of PDF files. | |
GetCurrentImageBytesSize | Returns size of current image in BMP format. | |
GetCurrentImageBytesSize(ImageFormat) | Returns size of current image in specified format. | |
GetCurrentImageRectangle | Returns coordinates of the bounding rectangle of the image | |
GetCurrentImageRectangle_Height | Returns height of the current image image | |
GetCurrentImageRectangle_Left | Returns left coordinate of the current image image | |
GetCurrentImageRectangle_Top | Returns top coordinate of the current image image | |
GetCurrentImageRectangle_Width | Returns width of the current image image | |
GetDocumentImageCount | Returns count of images in the document. | |
GetFirstImage | Initializes enumeration of images in the document. If GetFirstImage() returned true, you can get the image using SaveCurrentImage*() or GetCurrentImage*() methods. | |
GetFirstPageImage | Initializes enumeration of images on the document page. If GetFirstPageImage() returned true, you can get the image using SaveCurrentImage*() or GetCurrentImage*() methods. Call GetNextImage() to advance the enumeration. | |
GetHashCode | (Inherited from Object.) | |
GetNextImage | Advances image enumeration to next image. If GetNextImage() returned true, you can get the image using SaveCurrentImage*() or GetCurrentImage*() methods. | |
GetPageCount | Returns document page count. (Inherited from BaseExtractor.) | |
GetPageImageCount | Returns count of images on specified document page. | |
GetPageRect_Height | Gets the specified page height. (Inherited from BaseExtractor.) | |
GetPageRect_Left | Gets the specified page left coordinate. (Inherited from BaseExtractor.) | |
GetPageRect_Top | Gets the specified page top coordinate. (Inherited from BaseExtractor.) | |
GetPageRect_Width | Gets the specified page width. (Inherited from BaseExtractor.) | |
GetPageRectangle(Int32) | Gets the page rectangle in PDF Points (1 Point = 1/72 in.). (Inherited from BaseExtractor.) | |
GetPageRectangle(Int32, Boolean) | Gets the page rectangle in PDF Points (1 Point = 1/72 in.). (Inherited from BaseExtractor.) | |
GetPageRotationAngle | Returns the rotation angle of specified page. (Inherited from BaseExtractor.) | |
GetType | (Inherited from Object.) | |
IsEncrypted | Gets the document encrypted state. (Inherited from BaseExtractor.) | |
LoadAndApplyProfiles | Loads profiles from JSON string and automatically applies them. Note that profiles containing detection keywords will be deferred until the extraction. (Inherited from BaseExtractor.) | |
LoadDocumentFromFile | Loads PDF document from specified file. (Inherited from BaseExtractor.) | |
LoadDocumentFromStream | Loads PDF document from provided stream. (Inherited from BaseExtractor.) | |
LoadDocumentFromVariant | Loads PDF document from byte array presented as array of Variant or Byte objects ('Variant()' or 'Byte()'). This is COM/ActiveX-compatible version of the method LoadDocumentFromStream(Stream) for in-memory processing of PDF files. (Inherited from BaseExtractor.) | |
LoadProfiles | Loads profiles from JSON file. (Inherited from BaseExtractor.) | |
LoadProfilesFromString | Loads profiles from JSON string. (Inherited from BaseExtractor.) | |
MemberwiseClone | (Inherited from Object.) | |
Reset | Resets the ImageExtractor instance and disposes internal resources. (Overrides BaseExtractorReset.) | |
ResetExtractionArea | Resets the extraction area to full page. (Overrides BaseExtractorResetExtractionArea.) | |
SaveCurrentImageToFile(String) | Saves current image to PNG file with specified name. | |
SaveCurrentImageToFile(String, ImageFormat) | Saves current image to a file with specified name and format. | |
SaveCurrentImageToStream(Stream) | Saves current image to provided stream in PNG format. | |
SaveCurrentImageToStream(Stream, ImageFormat) | Saves current image to the stream with specified format. | |
SetExtractionArea(RectangleF) | Sets the extraction area by rectangle. (Overrides BaseExtractorSetExtractionArea(RectangleF).) | |
SetExtractionArea(Double, Double, Double, Double) | Sets the extraction area by coordinates and dimensions. (Inherited from BaseExtractor.) | |
SetExtractionArea(Single, Single, Single, Single) | Sets the extraction area by coordinates and dimensions. (Overrides BaseExtractorSetExtractionArea(Single, Single, Single, Single).) | |
ToString | (Inherited from Object.) |
Events
Name | Description | |
---|---|---|
ParsingError | Raised on PDF document parsing errors. This usually indicates a damaged document. (Inherited from BaseExtractor.) | |
PasswordRequired | Occurs when the password required to decrypt the document. (Inherited from BaseExtractor.) | |
ProgressChanged | Raised for each reported progress value. Allows to cancel the processing. (Inherited from BaseExtractor.) |
Fields
Name | Description | |
---|---|---|
ExtractionAreaInternal | (Inherited from BaseExtractor.) |
See Also