ImageExtractor ClassByteScout PDF Extractor SDK
Extracts images from PDF document.
Inheritance Hierarchy

SystemObject
  Bytescout.PDFExtractorBaseExtractor
    Bytescout.PDFExtractorImageExtractor

Namespace:  Bytescout.PDFExtractor
Assembly:  Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 12.0.0.4062-master
Syntax

public class ImageExtractor : BaseExtractor, 
	IImageExtractor

The ImageExtractor type exposes the following members.

Constructors

  NameDescription
Public methodImageExtractor
Initializes a new instance of the ImageExtractor class.
Public methodImageExtractor(String, String)
Initializes a new instance of the ImageExtractor class.
Top
Properties

  NameDescription
Public propertyCheckPermissions
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.)
Public propertyComHelpers
Set of utility functions and properties to use from COM/ActiveX.
(Inherited from BaseExtractor.)
Public propertyContentType
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.)
Public propertyEmbeddedFileCount Obsolete.
Property is disabled to speed up the document loading. Use AttachmentExtractor to work with attachments.
(Inherited from BaseExtractor.)
Public propertyEncrypted
Gets whether the document is encrypted.
(Inherited from BaseExtractor.)
Public propertyExtractionArea
Sets the extraction area by coordinates and dimensions.
(Inherited from BaseExtractor.)
Public propertyExtractionAreaRect
Sets the extraction area by rectangle.
(Inherited from BaseExtractor.)
Public propertyExtractionAreaUsageMode
Controls how an extraction area (if any defined) is used when doing a text search to control if we are searching within any objects intersecting with an area or only within objects completely inside an area
(Inherited from BaseExtractor.)
Public propertyExtractRawImages
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 casues to extract images rescaled according to scaling and skews defined for rendering (so image extractor provides images similar to what you see).
Public propertyIsDocumentLoaded
Get the document loaded state.
(Inherited from BaseExtractor.)
Public propertyLicenseInfo
Gets license information.
(Inherited from BaseExtractor.)
Public propertyPageDataCaching
Controls page data caching behavior.
(Inherited from BaseExtractor.)
Public propertyPassword
PDF document password.
(Inherited from BaseExtractor.)
Public propertyProfiles
Comma-separated list of profiles to apply to the extractor. Profiles must be previously loaded.
(Inherited from BaseExtractor.)
Public propertyRegistrationKey
Registration key.
(Inherited from BaseExtractor.)
Public propertyRegistrationName
Registration name.
(Inherited from BaseExtractor.)
Public propertyVersion
Gets the component version number.
(Inherited from BaseExtractor.)
Top
Methods

  NameDescription
Public methodCreateProfile(String, Boolean) (Inherited from BaseExtractor.)
Public methodCreateProfile(String, String, Boolean) (Inherited from BaseExtractor.)
Public methodDispose
Releases the unmanaged resources used by the instance and optionally releases the managed resources.
(Inherited from BaseExtractor.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodFireParsingError (Inherited from BaseExtractor.)
Protected methodFireProgressChanged (Inherited from BaseExtractor.)
Public methodGetCurrentImageAsArrayOfBytes
Returns current image as array of bytes in BMP format.
Public methodGetCurrentImageAsArrayOfBytes(ImageFormat)
Returns current image as array of bytes in specified format.
Public methodGetCurrentImageBytesSize
Returns size of current image in BMP format.
Public methodGetCurrentImageBytesSize(ImageFormat)
Returns size of current image in specified format.
Public methodGetCurrentImageRectangle
Returns coordinates of the bounding rectangle of the image
Public methodGetCurrentImageRectangle_Height
Returns height of the current image image
Public methodGetCurrentImageRectangle_Left
Returns left coordinate of the current image image
Public methodGetCurrentImageRectangle_Top
Returns top coordinate of the current image image
Public methodGetCurrentImageRectangle_Width
Returns width of the current image image
Public methodGetDocumentImageCount
Returns count of images in the document.
Public methodGetFirstImage
Initializes enumeration of images in the document. If GetFirstImage() returned true, you can get the image using SaveCurrentImage*() or GetCurrentImage*() methods.
Public methodGetFirstPageImage
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.
Public methodGetHashCode (Inherited from Object.)
Public methodGetNextImage
Advances image enumeration to next image. If GetNextImage() returned true, you can get the image using SaveCurrentImage*() or GetCurrentImage*() methods.
Public methodGetPageCount
Returns document page count.
(Inherited from BaseExtractor.)
Public methodGetPageImageCount
Returns count of images on specified document page.
Public methodGetPageRect_Height
Gets the specified page height.
(Inherited from BaseExtractor.)
Public methodGetPageRect_Left
Gets the specified page left coordinate.
(Inherited from BaseExtractor.)
Public methodGetPageRect_Top
Gets the specified page top coordinate.
(Inherited from BaseExtractor.)
Public methodGetPageRect_Width
Gets the specified page width.
(Inherited from BaseExtractor.)
Public methodGetPageRectangle(Int32)
Gets the page rectangle in PDF Points (1 Point = 1/72 in.).
(Inherited from BaseExtractor.)
Public methodGetPageRectangle(Int32, Boolean)
Gets the page rectangle in PDF Points (1 Point = 1/72 in.).
(Inherited from BaseExtractor.)
Public methodGetPageRotationAngle
Returns the rotation angle of specified page.
(Inherited from BaseExtractor.)
Public methodGetType (Inherited from Object.)
Public methodIsEncrypted
Gets the document encrypted state.
(Inherited from BaseExtractor.)
Public methodLoadAndApplyProfiles
Loads profiles from JSON string and automatically applies them. Note that profiles containing detection keywords will be deferred until the extraction.
(Inherited from BaseExtractor.)
Public methodLoadDocumentFromFile
Loads PDF document from specified file.
(Inherited from BaseExtractor.)
Public methodLoadDocumentFromStream
Loads PDF document from provided stream.
(Inherited from BaseExtractor.)
Public methodLoadProfiles
Loads profiles from JSON file.
(Inherited from BaseExtractor.)
Public methodLoadProfilesFromString
Loads profiles from JSON string.
(Inherited from BaseExtractor.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodReset
Resets the ImageExtractor instance and disposes internal resources.
(Overrides BaseExtractorReset.)
Public methodResetExtractionArea
Resets the extraction area to full page.
(Overrides BaseExtractorResetExtractionArea.)
Public methodSaveCurrentImageToFile(String)
Saves current image to PNG file with specified name.
Public methodSaveCurrentImageToFile(String, ImageFormat)
Saves current image to a file with specified name and format.
Public methodSaveCurrentImageToStream(Stream)
Saves current image to provided stream in PNG format.
Public methodSaveCurrentImageToStream(Stream, ImageFormat)
Saves current image to the stream with specified format.
Public methodSetExtractionArea(RectangleF)
Sets the extraction area by rectangle.
(Overrides BaseExtractorSetExtractionArea(RectangleF).)
Public methodSetExtractionArea(Double, Double, Double, Double)
Sets the extraction area by coordinates and dimensions.
(Inherited from BaseExtractor.)
Public methodSetExtractionArea(Single, Single, Single, Single)
Sets the extraction area by coordinates and dimensions.
(Overrides BaseExtractorSetExtractionArea(Single, Single, Single, Single).)
Public methodToString (Inherited from Object.)
Top
Events

  NameDescription
Public eventParsingError
Raised on PDF document parsing errors. This usually indicates a damaged document.
(Inherited from BaseExtractor.)
Public eventPasswordRequired
Occurs when the password required to decrypt the document.
(Inherited from BaseExtractor.)
Public eventProgressChanged
Raised for each reported progress value. Allows to cancel the processing.
(Inherited from BaseExtractor.)
Top
Fields

  NameDescription
Protected fieldExtractionAreaInternal (Inherited from BaseExtractor.)
Top
See Also

Reference