DocumentSplitter2 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
Represents PDF document splitter that splits a document by pages containing specific text.
Inheritance Hierarchy
Bytescout.PDFExtractorDocumentSplitter2
Namespace:Bytescout.PDFExtractor
Assembly: Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 13.4.0.4760-master
Syntax
The DocumentSplitter2 type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | DocumentSplitter2 | Initializes a new instance of the DocumentSplitter2 class. |
| DocumentSplitter2(String, String) | Initializes a new instance of the DocumentSplitter2 class. |
Properties
| Name | Description | |
|---|---|---|
 | CheckPermissions | Defines whether respect permissions set by document owner. If True, extractor throws exception when the extraction is prohibited. |
| 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. |
| OptimizeSplittedDocuments | Removes unused resources from splitted document parts. |
| Password | PDF document password. |
| RegistrationKey | Registration key. |
| RegistrationName | Registration name. |
| Version | Gets the component version number. |
Methods
| Name | Description | |
|---|---|---|
| Dispose | Releases all resources used by the DocumentSplitter2 |
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
 | MakeRanges | |
| MemberwiseClone | (Inherited from Object.) |
| Split(Stream, String, Boolean, Boolean, Boolean) | Splits PDF or TIFF document by found text. |
| Split(String, String, Boolean, Boolean, Boolean, String) | Splits PDF or TIFF document by found text. |
| SplitCOM | Splits PDF or TIFF document by found text. The COM/ActiveX-compatible version of the method Split(String, String, Boolean, Boolean, Boolean, String). Returns a string with the file names of the generated PDF documents delimited by the line feed '\n'. |
| SplitToVariant | Splits PDF or TIFF document by found text and returns the result PDF documents as array of byte arrays. This is COM/ActiveX-compatible version of the method Split(Stream, String, Boolean, Boolean, Boolean) for in-memory processing of PDF files. |
| ToString | (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
 | PasswordRequired | Occurs when the password required to decrypt the document. |
| ProgressChanged | Raised for each reported progress value. Allows to cancel the processing. |
See Also