Return to previous page Explore PDF Extractor SDK

BaseExtractor 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

Defines a base class for PDF extractors.

Inheritance Hierarchy

SystemObject
Bytescout.PDFExtractorBaseExtractor
More...

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

Syntax

C++

Copy

public abstract class BaseExtractor : IBaseExtractor, 
	IDisposable, IExtractionArea, IProfiles

Public MustInherit Class BaseExtractor
	Implements IBaseExtractor, IDisposable, IExtractionArea, IProfiles

public ref class BaseExtractor abstract : IBaseExtractor, 
	IDisposable, IExtractionArea, IProfiles

[<AbstractClassAttribute>]
type BaseExtractor =  
    class
        interface IBaseExtractor
        interface IDisposable
        interface IExtractionArea
        interface IProfiles
    end

The BaseExtractor type exposes the following members.

Constructors

	Name	Description
	BaseExtractor	Default constructor.
	BaseExtractor(String, String)	Initializes a new instance of the extractor class.

Top

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.
	ComHelpers	Set of utility functions and properties to use from COM/ActiveX.
	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.
	EmbeddedFileCount	Obsolete. Property is disabled to speed up the document loading. Use AttachmentExtractor to work with attachments.
	Encrypted	Gets whether the document is encrypted.
	ExtractionArea	Sets the extraction area by coordinates and dimensions (left, top, width, height).
	ExtractionAreaRect	Sets the extraction area by rectangle.
	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.
	IsDocumentLoaded	Get the document loaded state.
	LicenseInfo	Gets license information.
	PageDataCaching	Controls page data caching behavior.
	Password	PDF document password.
	Profiles	Comma-separated list of profiles to apply to the extractor. Profiles must be previously loaded.
	RegistrationKey	Registration key.
	RegistrationName	Registration name.
	Version	Gets the component version number.

Top

Methods

	Name	Description
	CreateProfile(String, Boolean, Boolean, Boolean)	Creates JSON profile will all extractor properties with current values.
	CreateProfile(String, String, Boolean, Boolean, Boolean)	Creates JSON profile will all extractor properties with current values.
	Dispose	Releases the unmanaged resources used by the instance and optionally releases the managed resources.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	FireParsingError
	FireProgressChanged
	GetHashCode	(Inherited from Object.)
	GetPageCount	Returns document page count.
	GetPageRect_Height	Gets the specified page height.
	GetPageRect_Left	Gets the specified page left coordinate.
	GetPageRect_Top	Gets the specified page top coordinate.
	GetPageRect_Width	Gets the specified page width.
	GetPageRectangle(Int32)	Gets the page rectangle in PDF Points (1 Point = 1/72 in.).
	GetPageRectangle(Int32, Boolean)	Gets the page rectangle in PDF Points (1 Point = 1/72 in.).
	GetPageRotationAngle	Returns the rotation angle of specified page.
	GetType	(Inherited from Object.)
	IsEncrypted	Gets the document encrypted state.
	LoadAndApplyProfiles	Loads profiles from JSON string and automatically applies them. Note that profiles containing detection keywords will be deferred until the extraction.
	LoadDocumentFromFile	Loads PDF document from specified file.
	LoadDocumentFromStream	Loads PDF document from provided stream.
	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.
	LoadProfiles	Loads profiles from JSON file.
	LoadProfilesFromString	Loads profiles from JSON string.
	MemberwiseClone	(Inherited from Object.)
	Reset	Resets the instance, disposes internal resources and releases the file. Use this method before loading another PDF file.
	ResetExtractionArea	Resets the extraction area to the full page.
	SetExtractionArea(RectangleF)	Sets the extraction area by rectangle.
	SetExtractionArea(Double, Double, Double, Double)	Sets the extraction area by coordinates and dimensions.
	SetExtractionArea(Single, Single, Single, Single)	Sets the extraction area by coordinates and dimensions.
	ToString	(Inherited from Object.)

Top

Events

	Name	Description
	ParsingError	Raised on PDF document parsing errors. This usually indicates a damaged document.
	PasswordRequired	Occurs when the password required to decrypt the document.
	ProgressChanged	Raised for each reported progress value. Allows to cancel the processing.

Top

Fields

	Name	Description
	ExtractionAreaInternal

Top

Reference

Bytescout.PDFExtractor Namespace

Inheritance Hierarchy