Link Search Menu Expand Document

SearchablePDFMaker Class

Represents Searchable PDF Maker tool.
Inheritance Hierarchy
SystemObject
Bytescout.PDFExtractorBaseExtractor
Bytescout.PDFExtractorSearchablePDFMaker

Namespace:Bytescout.PDFExtractor
Assembly: Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 13.0.1.4281-master
Syntax
public class SearchablePDFMaker : BaseExtractor, 
	ISearchablePDFMaker, IBaseExtractor, IDisposable

The SearchablePDFMaker type exposes the following members.

Constructors
NameDescription
Public methodSearchablePDFMaker
Initializes a new instance of SearchablePDFMaker class.
Public methodSearchablePDFMaker(String, String)
Initializes a new instance of SearchablePDFMaker 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 propertyDiscardExistingDocumentText
Gets or sets whether to discard any existing text in the document. Default is false (combine the recognized text with existing content).
Public propertyEmbeddedFileCountObsolete.
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 (left, top, width, height).
(Inherited from BaseExtractor.)
Public propertyExtractionAreaRect
Sets the extraction area by rectangle.
(Inherited from BaseExtractor.)
Public propertyExtractionAreaUsageMode
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.)
Public propertyIsDocumentLoaded
Get the document loaded state.
(Inherited from BaseExtractor.)
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 BaseExtractor.)
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 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, Boolean, Boolean)
Creates JSON profile will all extractor properties with current values.
(Inherited from BaseExtractor.)
Public methodCreateProfile(String, String, Boolean, Boolean, Boolean)
Creates JSON profile will all extractor properties with current values.
(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 methodGetHashCode (Inherited from Object.)
Public methodGetPageCount
Returns document page count.
(Inherited from BaseExtractor.)
Public methodGetPageOCRCells(Int32)
Processes the document with OCR (Optical Character Recognition), adds returns recognized data as array of OCRCell.
Public methodGetPageOCRCells(Int32, Int32)
Processes the document with OCR (Optical Character Recognition), and returns recognized data as array of OCRCell.
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 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 BaseExtractor.)
Public methodLoadProfiles
Loads profiles from JSON file.
(Inherited from BaseExtractor.)
Public methodLoadProfilesFromString
Loads profiles from JSON string.
(Inherited from BaseExtractor.)
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).
Protected methodMemberwiseClone (Inherited from Object.)
Public methodReset
Resets the instance and disposes internal resources. Also automatically invoked by Dispose.
(Overrides BaseExtractorReset.)
Public methodResetExtractionArea
Resets the extraction area to the full page.
(Inherited from BaseExtractor.)
Public methodSetExtractionArea(RectangleF)
Sets the extraction area by rectangle.
(Inherited from BaseExtractor.)
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.
(Inherited from BaseExtractor.)
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


Copyright © 2016 - 2021 ByteScout