Link Search Menu Expand Document

SensitiveDataDetector Class

Class that detects sensitive data in PDF documents.
Inheritance Hierarchy
SystemObject
Bytescout.PDFExtractorSensitiveDataDetector

Namespace:Bytescout.PDFExtractor
Assembly: Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 13.0.1.4281-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. Sets the minimal total length of normal text objects on the current page to decide whether to perform OCR or not. If the length of the text is less than this value then extractor will use OCR for this page. Otherwise it extracts the existing normal text objects only.
Public propertyOCRBlackList
A set of characters not allowed to be recognized from scanned document. The resulting text will only contain characters that are not in this list. This helps improve uncertain recognition.
Public propertyOCRCorrections
A set of corrections automatically applied to recognized text to fix repeating recognition errors.
Public propertyOCRDetectPageRotation
Sets whether to detect scanned page rotation. Slightly slows down the processing.
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
A set of corrections automatically applied to recognized text to fix repeating recognition errors.
Public propertyOCRLanguage
Language of OCR (Optical Character Recognition). 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 use of the OCR (Optical Character Recognition) which allows you to recognize text from images embedded in PDF pages. Set the language using the OCRLanguage property.

This option requires Bytescout.PDFExtractor.OCRExtension.dll assembly reference and relevant 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 OCR (Optical Character Recognition). Default is 300 DPI.
Public propertyOCRWhiteList
A set of characters allowed to be recognized from scanned document. Only characters from this list will appear in the result text. This helps improve uncertain recognition.
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.
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.
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


Copyright © 2016 - 2021 ByteScout