Free Trial
Web API version
Licensing
Request A Quote
HAVE QUESTIONS OR NEED HELP? SUBMIT THE SUPPORT REQUEST FORM or write email to SUPPORT@BYTESCOUT.COM
The BaseTextExtractor type exposes the following members.
Properties
Name | Description | |
---|---|---|
![]() | AutoAlignColumnsToHeader |
Gets or sets a value indicating whether to auto align text in columns while extracting text (with formatting preserved), csv, xml or not.
True by default (i.e. align text in columns and header).
False means to not auto align text and try to reproduce the original table.
|
![]() | 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.
(Inherited from BaseExtractor.) |
![]() | ColumnDetectionByTextAlignment |
Gets or set the visual text alignment in table cells. It helps to detect columns when tables don't have vertical
separating lines between columns and the columns are formed by text alignment.
|
![]() | ColumnDetectionMode |
Sets how columns are detected.
Default: ContentGroupsAndBorders (columns are detected based on content groups and borders (vertical lines)).
|
![]() | ComHelpers |
Set of utility functions and properties to use from COM/ActiveX.
(Inherited from BaseExtractor.) |
![]() | ConsiderFontColors |
Consider font colors in document text when detecting table structure. False by default.
|
![]() | ConsiderFontNames |
Consider font names in document text when detecting table structure. False by default.
|
![]() | ConsiderFontSizes |
Consider font sizes in document text when detecting table structure. False by default.
|
![]() | ConsiderVerticalBorders |
Consider vertical borders in document text when detecting table structure and merging text objects. True by default.
|
![]() | ContentType |
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.) |
![]() | CustomExtractionColumns |
Allows to override the automatic columns detection with custom columns.
|
![]() | DetectLinesInsteadOfParagraphs | Obsolete.
Lines detection option.
Obsolete: Use LineGroupingMode instead.
|
![]() | DetectNewColumnBySpacesRatio |
Space ratio between words.
|
![]() | EmbeddedFileCount | Obsolete.
Property is disabled to speed up the document loading. Use AttachmentExtractor to work with attachments.
(Inherited from BaseExtractor.) |
![]() | EnableTextAnalysis |
Enables or disables extracted text analysis. Check TextAnalysisResults after the extraction for analysis results.
|
![]() | Encrypted |
Gets whether the document is encrypted.
(Inherited from BaseExtractor.) |
![]() | ExtractAnnotations |
Gets or sets a value indicating whether to extract text from annotation objects. Default is true.
|
![]() | ExtractColumnByColumn |
Gets or sets a value indicating whether to extract text column by column or use the visual layout of the text while extracting.
False by default.
if you are processing PDF newspapers with text columns, set this property to True so you get column by column instead of line by line
|
![]() | ExtractInvisibleText |
Gets or sets a value indicating whether to extract invisible text from PDF document.
|
![]() | ExtractionArea |
Sets the extraction area by coordinates and dimensions.
(Inherited from BaseExtractor.) |
![]() | ExtractionAreaRect |
Sets the extraction area by rectangle.
(Inherited from BaseExtractor.) |
![]() | ExtractionAreaUsageMode |
Controls how an extraction area (if any defined)
is used when doing a text search to control if we are searching
within any objects intersecting with an area or only within objects completely inside an area
(Inherited from BaseExtractor.) |
![]() | ExtractionColumns |
Contains columns detected from last processed document page.
|
![]() | ExtractShadowLikeText |
Gets or sets a value indicating whether to include characters used to create "shadow" effect (when the same character appears with some offset) from PDF document.
True by default (includes all encoded characters disregarding their real appearance).
|
![]() | IsDocumentLoaded |
Get the document loaded state.
(Inherited from BaseExtractor.) |
![]() | LicenseInfo |
Gets license information.
(Inherited from BaseExtractor.) |
![]() | LineGroupingMode |
Sets how lines are grouped into paragraphs.
Default: None (no lines grouping is performed).
|
![]() | OCRAutoModeMinExistingTextLength |
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.
|
![]() | OCRBlackList | 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.
|
![]() | OCRCacheMode |
OCR results caching behaviour.
Turned off by default (no cache is used).
In "WholePage" caching mode you may save processing time as the SDK will check if need to re-run OCR on the page
or can just pull results from previously cached OCR results.
|
![]() | OCRCorrections |
Collection of corrections automatically applied to recognized text to fix repeating recognition errors.
|
![]() | OCRDetectPageRotation |
Gets or sets whether to detect scanned page rotation. Slightly slows down the processing time.
|
![]() | OCRImagePreprocessingFilters |
Collection of image processing filters applied to the document page before Optical Character Recognition (OCR). May improve the recognition quality.
|
![]() | OCRLanguage |
Language for Optical Character Recognition (OCR). 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 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. |
![]() | OCROverallConfidence |
Gets overall OCR confidence. This value is calculated after the extraction is performed.
|
![]() | OCRResolution |
Resolution of Optical Character Recognition (OCR). Default is 300 DPI.
|
![]() | OCRWhiteList | 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.
|
![]() | PageDataCaching |
Controls page data caching behavior.
(Inherited from BaseExtractor.) |
![]() | Password |
PDF document password.
(Inherited from BaseExtractor.) |
![]() | PreserveFormattingOnTextExtraction |
Gets or sets a value indicating whether to preserve the text formatting on the extraction.
|
![]() | Profiles |
Comma-separated list of profiles to apply to the extractor. Profiles must be previously loaded.
(Inherited from BaseExtractor.) |
![]() | RegistrationKey |
Registration key.
(Inherited from BaseExtractor.) |
![]() | RegistrationName |
Registration name.
(Inherited from BaseExtractor.) |
![]() | RemoveHyphenation |
Gets or sets a value indicating whether to automatically remove hyphenations in end of lines (works when Unwrap is True).
|
![]() | RotationAngle |
Gets or sets whether to rotate document pages to specified angle before the extraction.
|
![]() | RTLTextAutoDetectionEnabled |
Enables RTL (Right-To-Left) text auto detection. Default is true.
|
![]() | ShrinkMultipleSpaces |
Replaces multiple spaces in text objects with a single space.
Multiple spaces affect the detection of columns, so removing them can improve the result.
Default is false.
|
![]() | TableXMinIntersectionRequiredInPercents |
Structured extraction (CSV, XML, XLS, StructuredExtractor, TextExtractor with PreserveFormatting = true)
This option controls how much % of the cell's rectangle should intersect (by X coordinate axis) with previous cell to treat both cells belonging to the same column.
|
![]() | TableYMinIntersectionRequiredInPercents |
Y coordinate tolerance factor when working with stuctured (table) data.
This option controls how much % of the cell rectangle (by Y coordinate) should intersect with row to belong to it.
|
![]() | TextAnalysisCorruptedTextThreshold |
The criterion of detection of the corrupted text used in text analysis. Default is 0.5.
|
![]() | TextAnalysisResults |
Results of the text analysis. Enable the analysis using EnableTextAnalysis property.
|
![]() | TextEncodingCodePage |
Sets the default text encoding. Default encoding is "iso-8859-1".
|
![]() | TrimSpaces |
Gets or sets a value indicating whether to remove trailing and ending spaces from table cell values.
|
![]() | Unwrap |
Gets or sets a value indicating whether to unwrap lines into single lines or not (especially could be useful in the column layout mode - see ExtractColumnByColumn property). Default is False.
|
![]() | Version |
Gets the component version number.
(Inherited from BaseExtractor.) |
![]() | XCoordinateToleranceFactor |
X coordinate tolerance factor.
|
![]() | YCoordinateToleranceFactor |
Y coordinate tolerance factor.
|
See Also