IBaseExtractor InterfaceByteScout PDF Extractor SDK
Defines a base interface for PDF extractors.

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

public interface IBaseExtractor : IDisposable

The IBaseExtractor type exposes the following members.

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.
Public propertyComHelpers
Set of helping methods for use from COM/ActiveX.
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.
Public propertyIsDocumentLoaded
Get the document loaded state.
Public propertyLicenseInfo
Gets license information.
Public propertyPageDataCaching
Controls page data caching behavior.
Public propertyPassword
PDF document password.
Public propertyRegistrationKey
Registration key.
Public propertyRegistrationName
Registration name.
Public propertyVersion
Gets the component version number.
Top
Methods

  NameDescription
Public methodDispose (Inherited from IDisposable.)
Public methodGetPageCount
Returns document page count.
Public methodGetPageRect_Height
Gets the specified page height.
Public methodGetPageRect_Left
Gets the specified page left coordinate.
Public methodGetPageRect_Top
Gets the specified page top coordinate.
Public methodGetPageRect_Width
Gets the specified page width.
Public methodGetPageRectangle(Int32)
Gets the page rectangle in PDF Points (1 Point = 1/72 in.).
Public methodGetPageRectangle(Int32, Boolean)
Gets the page rectangle in PDF Points (1 Point = 1/72 in.).
Public methodGetPageRotationAngle
Returns the rotation angle of specified page.
Public methodIsEncrypted
Gets the document encrypted state.
Public methodLoadDocumentFromFile
Loads PDF document from specified file.
Public methodLoadDocumentFromStream
Loads PDF document from provided stream.
Public methodLoadDocumentFromVariant
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.
Public methodReset
Resets the instance, disposes internal resources and releases the file. Use this method before loading another PDF file.
Top
Events

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

Reference