Initializes a new instance of the XMLExtractor class.

Initializes a new instance of the XMLExtractor class.

Gets or sets whether to allow standalone punctuation characters. If false they will be merged with nearest text object.

Sets whether to align text in the columns to the header.

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.

Suggests the extractor 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.

Sets how columns are detected. Default is 'ContentGroupsAndBorders' - columns are detected by grouping of text objects and by vertical vector lines.

Set of utility functions and properties to use from COM/ActiveX.

Consider background colors under text objects when detecting table structure. It can be useful for striped tables, but may degrade extraction quality on scanned documents because of uneven image background. Default is false.

Consider font colors in document text when detecting table structure. Default is false.

Consider font names in document text when detecting table structure. Default is false.

Consider font sizes in document text when detecting table structure. Default is false.

Consider horizontal borders between text objects when detecting table structure and merging objects. Default is true.

Consider vertical borders between text objects when detecting table structure and merging objects. Default is true.

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.

Allows to override automatic columns detection with custom columns coordinates.

Lines detection option. Obsolete: Use LineGroupingMode instead.

Space ratio between words. Large spacing is treated as column separator. Using this parameter you can control the column detection.

Get or sets whether to detect the "strikeout" text style. Default is false.

Get or sets whether to detect the "underline" text style. Default is false.

Property is disabled to speed up the document loading. Use AttachmentExtractor to work with attachments.

Enables or disables extracted text analysis. Check TextAnalysisResults after the extraction for analysis results.

Gets whether the document is encrypted.

Sets whether to extract text from annotation objects. Default is true.

Sets whether we should reconstruct table structure or extract text objects as they go in the PDF document stream. Default is true.

Sets whether to extract invisible text from a PDF document.

Sets the extraction area by coordinates and dimensions (left, top, width, height).

Sets the extraction area by rectangle.

Gets or sets how to use the ExtractionArea: whether to extract any object intersecting with the area or only objects completely located inside the area.

Contains columns detected from last processed document page.

Sets whether to extract shadow-like text from a PDF document (when the same text is drawn twice with small offset). Default is 'true' - includes all decoded text, regardless of its appearance.

Gets or sets the folder to put extracted images when SaveImages property is set to ImageHandling.OuterFile. Default is "images" - the extractor will create "images" sub-folder in the same folder with output XML file.

Gets or sets the image format for extracted images. Default is PNG.

Get or sets whether to generate indented XML. Default is true.

Get the document loaded state.

By default XMLExtractor replaces names of embedded fonts with standard (or "descendant") fonts similar by metrics and typeface. This is because embedded fonts differ from fonts installed into your system or absent there at all. Set this property to true if you want to keep the original font names.

Gets license information.

Sets how lines are grouped into paragraphs. Default is None (no line grouping is performed).

Set whether the extracted text should be normalized. Default is false.

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.

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.

Sets caching of OCR results. Default is Off (no caching). In WholePage caching mode you can save processing time as the SDK will check if need to re-run OCR on the page or it can just pull results from previously cached OCR results.

A set of corrections automatically applied to recognized text to fix repeating recognition errors.

Sets whether to detect horizontal and vertical lines during OCR. They help to detect the table structure in scanned documents. Default is false.

Sets whether to detect scanned page rotation. Slightly slows down the processing.

Sets whether to disable the automatic segmentation. All pages will be treated as containing sparse text (as a typical document such as an invoice).

A set of corrections automatically applied to recognized text to fix repeating recognition errors.

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.

Folder containing OCR language data files.

Gets or sets maximum OCR performance using Intel OpenMP (if available) to accelerate to approximately 30%. Default is false.

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.

Gets overall OCR confidence. This value is calculated after the extraction is performed.

Gets count of processed pages for which OCR was performed. This value is calculated after the extraction is finished.

Resolution of OCR (Optical Character Recognition). Default is 300 DPI.

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.

Controls page data caching behavior.

PDF document password.

Sets whether to preserve the text formatting on the extraction.

Comma-separated list of profiles to apply to the extractor. Profiles must be previously loaded.

Registration key.

Registration name.

Sets whether to automatically remove hyphenations in end of lines (works when is true).

Sets whether to rotate document pages to specified angle before the extraction.

Enables RTL (Right-To-Left) text auto detection. Default is true.

Get or sets the image saving way: do not save; save to outer file; embed into result XML as Base64 string. Default is ImageHandling.None.

Get or sets whether to save vector objects. Default is false.

Replaces multiple spaces in text objects with a single space. Multiple spaces affect column detection, so removing them may improve the result. Default is false.

During the reconstruction of table structure, sets how much of the cell rectangle should intersect (by X coordinate axis) with the previous cell to treat both cells belong to the same row.

During the reconstruction of table structure, sets how much of the cell rectangle should intersect (by Y coordinate axis) with the previous cell to treat both cells belong to the same column.

The criterion of detection of the corrupted text used in text analysis. Default is 0.5.

Results of the text analysis. Enable the analysis using EnableTextAnalysis property.

Sets the default text encoding. Default encoding is "iso-8859-1".

Sets whether to remove trailing and ending spaces from the text of table cells. Default is true.

Sets whether to unwrap the contents of a multiline table cell into a single line. Default is true.

Gets the component version number.

Sets X coordinate tolerance to use when constructing table structure of PDF page.

Sets Y coordinate tolerance to use when constructing table structure of PDF page.

Adds a filter to remove a text from extracted data.

Adds filter to exclude text objects with specified attributes.

Adds filter to exclude text objects with specified attributes.

Adds a filter to replace a text in extracted data.

Adds filter to exclude text objects with specified attributes.

Creates JSON profile will all extractor properties with current values.

Creates JSON profile will all extractor properties with current values.

Releases the unmanaged resources used by the instance and optionally releases the managed resources.

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.

Returns document page count.

Gets the specified page height.

Gets the specified page left coordinate.

Gets the specified page top coordinate.

Gets the specified page width.

Gets the page rectangle in PDF Points (1 Point = 1/72 in.).

Gets the page rectangle in PDF Points (1 Point = 1/72 in.).

Returns the rotation angle of specified page.

Returns extracted XML data as array of bytes. This is COM/ActiveX-compatible version of the method SavePageXMLToStream(Int32, Stream) for in-memory processing of PDF documents or images.

Returns preview image of document page with preprocessing filters applied.

Extracts XML data from the entire document as string.

Extracts XML data from specified page range.

Extracts XML data from specified page range.

Extracts XML data from specified page range.

Returns extracted XML data as array of bytes. This is COM/ActiveX-compatible version of the method SaveXMLToStream(Stream) for in-memory processing of PDF documents or images.

Returns extracted XML data as array of bytes. This is COM/ActiveX-compatible version of the method SaveXMLToStream(String, Stream) for in-memory processing of PDF documents or images.

Returns extracted XML data as array of bytes. This is COM/ActiveX-compatible version of the method SaveXMLToStream(Int32, Int32, Stream) for in-memory processing of PDF documents or images.

Extracts XML data from the entire document as XmlDocument.

Extracts XML data from specified pages as XmlDocument.

Extracts XML data from specified page ranges as XmlDocument.

Extracts XML data from specified page range as XmlDocument.

Extracts XML data from specified document page as XmlDocument.

Extracts XML data from specified document page as string.

Gets the document encrypted state.

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.

Loads profiles from JSON string and automatically applies them. Note that profiles containing detection keywords will be deferred until the extraction.

Loads PDF document from specified file.

Loads PDF document from provided stream.

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.

Loads profiles from JSON file.

Loads profiles from JSON string.

Resets the extraction area to the full page.

Reset text filters.

Saves page XML data to file.

Saves page XML data to stream.

Saves preview image of document page with preprocessing filters applied. Image is saved in PNG format.

Saves XML data from the entire document to file.

Saves XML data from specified pages to file.

Saves XML data from specified page ranges to file.

Saves XML data from specified page range to file.

Saves XML data to stream.

Saves XML data from specified pages to stream.

Saves XML data from specified page ranges to stream.

Saves XML data from specified page range to stream.

Helper method to set CustomExtractionColumns property when using the extractor though COM from VC++ VB, VBA, VBScript, or Delphi.

Sets the extraction area by rectangle.

Sets the extraction area by coordinates and dimensions.

Sets the extraction area by coordinates and dimensions.

Raised on PDF document parsing errors. This usually indicates a damaged document.

Occurs when the password required to decrypt the document.

Raised for each reported progress value. Allows to cancel the processing.