SensitiveDataDetector ClassByteScout PDF Extractor SDK
Class that detects sensitive data in PDF documents.
Inheritance Hierarchy

SystemObject
  Bytescout.PDFExtractorSensitiveDataDetector

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

public class SensitiveDataDetector : IBaseExtractor, 
	IDisposable, IBaseOCRExtractor, ISensitiveDataDetector

The SensitiveDataDetector type exposes the following members.

Constructors

  NameDescription
Public methodSensitiveDataDetector
Initializes a new instance of the SensitiveDataDetector class.
Public methodSensitiveDataDetector(String, String)
Initializes a new instance of the SensitiveDataDetector 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.
Public propertyIsDocumentLoaded
Get the document loaded state.
Public propertyLicenseInfo
Gets license information.
Public propertyOCRAutoModeMinExistingTextLength
Applies to OCRMode.Auto only: Min total length of existing text on current page to decide if OCR should be run or not. If the length of text is lesser than this property then library runs OCR for this page. Otherwise it extracts the existing text only.
Public propertyOCRBlackList
OCRBlackList property allows to define a list of characters not allowed to be recognized from scanned document. The resulting text will only contain characters that are not in this list.
Public propertyOCRCorrections
Collection of corrections automatically applied to recognized text to fix repeating recognition errors.
Public propertyOCRDetectPageRotation
Gets or sets whether to detect scanned page rotation. Slightly slows down the processing time.
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 propertyOCRMode
Enables Optical Character Recognition (OCR) to recognize text from embedded images. Set the language using OCRLanguage property.

This option requires Bytescout.PDFExtractor.OCRExtension.dll assembly and appropriate language files in OCRLanguageDataFolder folder. The SDK is shipped with language files for English, French, German and Spanish. You can download more languages at https://github.com/bytescout/ocrdata.

Public propertyOCRResolution
Resolution of Optical Character Recognition (OCR). Default is 300 DPI.
Public propertyOCRWhiteList
OCRWhiteList property allows to define a list of characters allowed to be recognized from scanned document. Only characters from this list will appear in the result text.
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
Releases the unmanaged resources used by the instance and optionally releases the managed resources.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGenerateReport
Generates sensitive data detection report in specified format.
Public methodGetHashCode (Inherited from Object.)
Public methodGetPageCount
Returns document page count.
Public methodGetSensitiveDataPolicies
Returns array of available sensitive data detection policies.
Public methodGetSensitiveDataPoliciesStr
Returns available sensitive data detection policies as array of strings.
Public methodGetType (Inherited from Object.)
Public methodIsEncrypted
Gets the document encrypted state.
Public methodIsOCRRecommendedForPage
Detects whether OCR is recommended for specified page. OCR (Optical Character Recognition) is recommended when pages has no text objects bat has an image that might contain text.
Public methodLoadDocumentFromFile
Loads PDF document from specified file.
Public methodLoadDocumentFromStream
Loads PDF document from provided stream.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodPerformDetection
Detects sensitive data in loaded document.
Public methodReset
Resets the instance, disposes internal resources and releases the file. Use this method before loading another PDF file.
Public methodToString (Inherited from Object.)
Top
Events

  NameDescription
Public eventParsingError
Public eventPasswordRequired
Occurs when the password required to decrypt the document.
Top
See Also

Reference