SensitiveDataDetector 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
Class that detects sensitive data in PDF documents.
Inheritance Hierarchy
Bytescout.PDFExtractorSensitiveDataDetector
Namespace:Bytescout.PDFExtractor
Assembly: Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 13.4.0.4760-master
Syntax
public class SensitiveDataDetector : IBaseExtractor, IDisposable, IBaseOCRExtractor, ISensitiveDataDetector
The SensitiveDataDetector type exposes the following members.
Constructors
Name | Description | |
---|---|---|
SensitiveDataDetector | Initializes a new instance of the SensitiveDataDetector class. | |
SensitiveDataDetector(String, String) | Initializes a new instance of the SensitiveDataDetector class. |
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. | |
IsDocumentLoaded | Get the document loaded state. | |
LicenseInfo | Gets license information. | |
OCRAutoModeMinExistingTextLength | 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. | |
OCRBlackList | 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. | |
OCRCorrections | A set of corrections automatically applied to recognized text to fix repeating recognition errors. | |
OCRDetectPageRotation | Sets whether to detect scanned page rotation. Slightly slows down the processing. | |
OCRDisableAutoSegmentation | Sets whether to disable the automatic segmentation. All pages will be treated as containing sparse text (as a typical document such as an invoice). | |
OCRImagePreprocessingFilters | A set of corrections automatically applied to recognized text to fix repeating recognition errors. | |
OCRLanguage | Language of OCR (Optical Character Recognition). The valid values are:
Download more languages at https://github.com/bytescout/ocrdata. | |
OCRLanguageDataFolder | Folder containing OCR language data files. | |
OCRMaximizeCPUUtilization | Gets or sets maximum OCR performance using Intel OpenMP (if available) to accelerate to approximately 30%. Default is false. | |
OCRMode | 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. | |
OCRResolution | Resolution of OCR (Optical Character Recognition). Default is 300 DPI. | |
OCRWhiteList | 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. | |
Password | PDF document password. | |
RegistrationKey | Registration key. | |
RegistrationName | Registration name. | |
Version | Gets the component version number. |
Methods
Name | Description | |
---|---|---|
Dispose | Releases the unmanaged resources used by the instance and optionally releases the managed resources. | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GenerateReport | Generates sensitive data detection report in specified format. | |
GetHashCode | (Inherited from Object.) | |
GetPageCount | Returns document page count. | |
GetSensitiveDataPolicies | Returns array of available sensitive data detection policies. | |
GetSensitiveDataPoliciesStr | Returns available sensitive data detection policies as array of strings. | |
GetType | (Inherited from Object.) | |
IsEncrypted | Gets the document encrypted state. | |
IsOCRRecommendedForPage | 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. | |
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. | |
MemberwiseClone | (Inherited from Object.) | |
PerformDetection | Detects sensitive data in loaded document. | |
Reset | Resets the instance, disposes internal resources and releases the file. Use this method before loading another PDF file. | |
ToString | (Inherited from Object.) |
Events
Name | Description | |
---|---|---|
ParsingError | ||
PasswordRequired | Occurs when the password required to decrypt the document. |
See Also