ISearchablePDFMaker InterfaceByteScout PDF Extractor SDK

[Missing <summary> documentation for "T:Bytescout.PDFExtractor.ISearchablePDFMaker"]

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

public interface ISearchablePDFMaker : IBaseExtractor, 
	IDisposable

The ISearchablePDFMaker 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.
(Inherited from IBaseExtractor.)
Public propertyComHelpers
Set of helping methods for use from COM/ActiveX.
(Inherited from IBaseExtractor.)
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 IBaseExtractor.)
Public propertyDiscardExistingDocumentText
Gets or sets whether to discard any existing text in the document. Default is false (combine the recognized text with existing content).
Public propertyIsDocumentLoaded
Get the document loaded state.
(Inherited from IBaseExtractor.)
Public propertyKeepOriginalRotation
Gets or sets whether to keep the original rotation of the document after making it searchable. Default is false.
Public propertyLabelingFont
Font used to put invisible text. By default the "Helvetica" is used, but this font does not contain Unicode character ranges. If you process document containing Chinese, Japanese, Korean characters (or any other Unicode charsets) you should set the font name containing required characters, for example, "Arial Unicode MS", "Microsoft JhengHei", etc.
Public propertyLicenseInfo
Gets license information.
(Inherited from IBaseExtractor.)
Public propertyOCRCorrections
Collection of corrections automatically applied to recognized text to fix repeating recognition errors.
Public propertyOCRDetectPageRotation
Detect scanned page rotation. Slightly slows down the processing time.
Public propertyOCRDisableAutoSegmentation
Sets whether to disable the automatic segmentation. All pages will be treated as containing sparse text (as a typical document such as an invoice).
Public propertyOCRImagePreprocessingFilters
Collection of image processing filters applied to the document page before Optical Character Recognition (OCR). May improve the recognition quality.
Public propertyOCRLanguage
Language for Optical Character Recognition (OCR). The valid values are:
  • "eng" - English (default)
  • "deu" - German
  • "fra" - French
  • "spa" - Spanish

Download more languages at https://github.com/bytescout/ocrdata.

Public propertyOCRLanguageDataFolder
Folder containing OCR language data files.
Public propertyOCRMaximizeCPUUtilization
Gets or sets maximum OCR performance using Intel OpenMP (if available) to accelerate to approximately 30%. Default is false.
Public propertyOCROverallConfidence
Gets overall OCR confidence. This value is calculated after the extraction is performed.
Public propertyOCRResolution
Resolution of Optical Character Recognition (OCR). Default is 300 DPI.
Public propertyPageDataCaching
Controls page data caching behavior.
(Inherited from IBaseExtractor.)
Public propertyPassword
PDF document password.
(Inherited from IBaseExtractor.)
Public propertyRegistrationKey
Registration key.
(Inherited from IBaseExtractor.)
Public propertyRegistrationName
Registration name.
(Inherited from IBaseExtractor.)
Public propertyVersion
Gets the component version number.
(Inherited from IBaseExtractor.)
Top
Methods

  NameDescription
Public methodDispose (Inherited from IDisposable.)
Public methodGetPageCount
Returns document page count.
(Inherited from IBaseExtractor.)
Public methodGetPageOCRCells
Processes the document with OCR (Optical Character Recognition), adds returns recognized data as array of OCRCell.
Public methodGetPageRect_Height
Gets the specified page height.
(Inherited from IBaseExtractor.)
Public methodGetPageRect_Left
Gets the specified page left coordinate.
(Inherited from IBaseExtractor.)
Public methodGetPageRect_Top
Gets the specified page top coordinate.
(Inherited from IBaseExtractor.)
Public methodGetPageRect_Width
Gets the specified page width.
(Inherited from IBaseExtractor.)
Public methodGetPageRectangle(Int32)
Gets the page rectangle in PDF Points (1 Point = 1/72 in.).
(Inherited from IBaseExtractor.)
Public methodGetPageRectangle(Int32, Boolean)
Gets the page rectangle in PDF Points (1 Point = 1/72 in.).
(Inherited from IBaseExtractor.)
Public methodGetPageRotationAngle
Returns the rotation angle of specified page.
(Inherited from IBaseExtractor.)
Public methodIsEncrypted
Gets the document encrypted state.
(Inherited from IBaseExtractor.)
Public methodLoadDocumentFromFile
Loads PDF document from specified file.
(Inherited from IBaseExtractor.)
Public methodLoadDocumentFromStream
Loads PDF document from provided stream.
(Inherited from IBaseExtractor.)
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.
(Inherited from IBaseExtractor.)
Public methodMakePDFSearchable(Stream)
Processes the document with OCR (Optical Character Recognition), adds the recognized characters as invisible text over the images and saves the result to specified Stream.
Public methodMakePDFSearchable(String)
Processes the document with OCR (Optical Character Recognition), adds the recognized characters as invisible text over the images and saves the result as new PDF file.
Public methodMakePDFSearchable(Stream, Int32)
Processes the document with OCR (Optical Character Recognition), adds the recognized characters as invisible text over the images and saves the result to specified Stream.
Public methodMakePDFSearchable(String, Int32)
Processes the document with OCR (Optical Character Recognition), adds the recognized characters as invisible text over the images and saves the result as new PDF file.
Public methodMakePDFSearchable(Stream, Int32, Int32)
Processes the document with OCR (Optical Character Recognition), adds the recognized characters as invisible text over the images and saves the result to specified Stream.
Public methodMakePDFSearchable(String, Int32, Int32)
Processes the document with OCR (Optical Character Recognition), adds the recognized characters as invisible text over the images and saves the result as new PDF file.
Public methodMakePDFSearchableToVariant
Processes the document with OCR (Optical Character Recognition), adds the recognized characters as invisible text over the images and returns the result PDF document as array of bytes. This is COM/ActiveX-compatible version of the method MakePDFSearchable(Stream).
Public methodMakePDFSearchableToVariant(Int32)
Processes the document with OCR (Optical Character Recognition), adds the recognized characters as invisible text over the images and returns the result PDF document as array of bytes. This is COM/ActiveX-compatible version of the method MakePDFSearchable(Stream, Int32).
Public methodMakePDFSearchableToVariant(Int32, Int32)
Processes the document with OCR (Optical Character Recognition), adds the recognized characters as invisible text over the images and returns the result PDF document as array of bytes. This is COM/ActiveX-compatible version of the method MakePDFSearchable(Stream, Int32, Int32).
Public methodReset
Resets the instance, disposes internal resources and releases the file. Use this method before loading another PDF file.
(Inherited from IBaseExtractor.)
Top
Events

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

Reference