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
Defines a base interface for PDF text extractors.
Namespace: Bytescout.PDFExtractor
Assembly: Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 12.0.0.4062-master
Syntax
The IBaseTextExtractor 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.
|
![]() | 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)).
|
![]() | 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 colors in document text when detecting table structure and merging text objects. True by default.
|
![]() | CustomExtractionColumns |
Allows to override the automatic columns detection with custom columns.
|
![]() | DetectLinesInsteadOfParagraphs |
Lines detection option.
Obsolete: Use LineGroupingMode instead.
|
![]() | DetectNewColumnBySpacesRatio |
Space ratio between words.
|
![]() | EnableTextAnalysis |
Enables or disables extracted text analysis. Check TextAnalysisResults after the extraction for analysis results.
|
![]() | ExtractAnnotations |
Gets or sets a value indicating whether to extract text from annotation objects. Default is true.
|
![]() | ExtractColumnByColumn |
Indicates if we should extract text column by column or should we use the original layout.
|
![]() | ExtractInvisibleText |
Gets or sets a value indicating whether to extract invisible text from PDF document.
|
![]() | 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).
|
![]() | LineGroupingMode |
When grouping text, each new line of text will start a new group (rather than paragraph grouping)
Default: None. (no merging is done. Just processing line by line).
|
![]() | 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.
(Inherited from IBaseOCRExtractor.) |
![]() | 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.
(Inherited from IBaseOCRExtractor.) |
![]() | 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.
(Inherited from IBaseOCRExtractor.) |
![]() | OCRCorrections |
Collection of corrections automatically applied to recognized text to fix repeating recognition errors.
(Inherited from IBaseOCRExtractor.) |
![]() | OCRDetectPageRotation |
Gets or sets whether to detect scanned page rotation. Slightly slows down the processing time.
(Inherited from IBaseOCRExtractor.) |
![]() | OCRImagePreprocessingFilters |
Collection of image processing filters applied to the document page before Optical Character Recognition (OCR). May improve the recognition quality.
(Inherited from IBaseOCRExtractor.) |
![]() | OCRLanguage |
Language for Optical Character Recognition (OCR). The valid values are:
(Inherited from IBaseOCRExtractor.)
Download more languages at https://github.com/bytescout/ocrdata. |
![]() | OCRLanguageDataFolder |
Folder containing OCR language data files.
(Inherited from IBaseOCRExtractor.) |
![]() | OCRMaximizeCPUUtilization |
Gets or sets maximum OCR performance using Intel OpenMP (if available) to accelerate to approximately 30%.
Default is false.
(Inherited from IBaseOCRExtractor.) |
![]() | OCRMode |
Enables Optical Character Recognition (OCR) to recognize text from embedded images.
Set the language using OCRLanguage property.
(Inherited from IBaseOCRExtractor.)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.
(Inherited from IBaseOCRExtractor.) |
![]() | OCRResolution |
Resolution of Optical Character Recognition (OCR). Default is 300 DPI.
(Inherited from IBaseOCRExtractor.) |
![]() | 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.
(Inherited from IBaseOCRExtractor.) |
![]() | PreserveFormattingOnTextExtraction |
Gets or sets a value indicating whether to preserve the text formatting on the extraction.
|
![]() | 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 |
Structured extraction (CSV, XML, XLS, StructuredExtractor, TextExtractor with PreserveFormatting = true)
This option controls how much % of the cell's rectangle should intersect (by Y coordinate axis) with previous cell to treat both cells belonging to the same row.
|
![]() | 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 |
Gets or sets the text encoding. Default code page is 28591 ("iso-8859-1").
|
![]() | TrimSpaces |
Trim spaces from text lines (FALSE by default to preserve original formatting if any).
|
![]() | Unwrap |
Unwraps lines in columns into one single.
True by default
|
![]() | XCoordinateToleranceFactor |
Sets X coordinate tolerance to use when reproducing the structure of PDF page content.
|
![]() | YCoordinateToleranceFactor |
Sets Y coordinate tolerance to use when reproducing the structure of PDF page content.
|
Methods
Name | Description | |
---|---|---|
![]() | AddFilter(String, Boolean, Boolean) |
Adds a filter to remove a text from extracted data.
|
![]() | AddFilter(String, Int32, Boolean) |
Adds filter to exclude text objects with specified attributes.
|
![]() | AddFilter(String, Int32, Color, Boolean) |
Adds filter to exclude text objects with specified attributes.
|
![]() | AddFilter(String, String, Boolean, Boolean) |
Adds a filter to replace a text in extracted data.
|
![]() | AddFilter(String, Int32, Int32, Int32, Int32, Boolean) |
Adds filter to exclude text objects with specified attributes.
|
![]() | DisposePage |
Disposes the page object.
Uses this method carefully to destroy the page object that should not be used further.
Useful to free allocated memory when processing huge PDF documents.
|
![]() | GetPreprocessedPagePreview |
Returns preview image of document page with preprocessing filters applied.
|
![]() | 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.
(Inherited from IBaseOCRExtractor.) |
![]() | ResetFilters |
Reset text filters.
|
![]() | SavePreprocessedPagePreview |
Saves preview image of document page with preprocessing filters applied. Image is saved in PNG format.
|
![]() | SetCustomExtractionColumns |
Helper method to set CustomExtractionColumns property when using the extractor
though COM from VC++ VB, VBA, VBScript, or Delphi.
|
See Also