Link Search Menu Expand Document

IJSONExtractor Interface

Defines the PDF to JSON extractor interface.

Namespace:Bytescout.PDFExtractor
Assembly: Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 13.4.0.4760-master
Syntax
public interface IJSONExtractor

The IJSONExtractor type exposes the following members.

Properties
NameDescription
Public propertyAllowStandalonePunctuation
Gets or sets whether to allow standalone punctuation characters. If false they will be merged with nearest text object.
Public propertyCleanJSON
Get or sets whether to generate regular JSON with camel-cased object identifiers without '@' (attribute) and '#' (node content) marks. Default is true.
Public propertyDetectStrikeoutTextStyle
Get or sets whether to detect the "strikeout" text style. Default is false.
Public propertyDetectUnderlineTextStyle
Get or sets whether to detect the "underline" text style. Default is false.
Public propertyImageFolder
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 JSON file.
Public propertyImageFormat
Gets or sets the image format for extracted images. Default is PNG.
Public propertyIndentedJSON
Get or sets whether to generate indented JSON. Default is true.
Public propertyKeepOriginalFontNames
By default JSONExtractor 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.
Public propertyOutputStructure
Gets or sets the structure of output JSON data.
Public propertyOutputTransformation
Gets or sets JSONPath ("XPath for JSON") expression that you can use to transform the output JSON.
Public propertySaveImages
Get or sets the image saving way: do not save; save to outer file; embed into result JSON as Base64 string. Default is ImageHandling.None.
Public propertySaveVectors
Get or sets whether to save vector objects. Default is false.
Top
Methods
NameDescription
Public methodGetJSONAsVariant
Returns extracted JSON data as array of bytes. This is COM/ActiveX-compatible version of the method SaveJSONToStream(Stream) for in-memory processing of PDF documents or images.
Public methodGetJSONAsVariant(String)
Returns extracted JSON data as array of bytes. This is COM/ActiveX-compatible version of the method SaveJSONToStream(String, Stream) for in-memory processing of PDF documents or images.
Public methodGetJSONAsVariant(Int32, Int32)
Returns extracted JSON data as array of bytes. This is COM/ActiveX-compatible version of the method SaveJSONToStream(Int32, Int32, Stream) for in-memory processing of PDF documents or images.
Public methodGetJSONData
Extracts data from whole document as JSON string.
Public methodGetJSONData(IListInt32)
Extracts data from specified pages as JSON string.
Public methodGetJSONData(Int32)
Extracts data from specified document page as JSON string.
Public methodGetJSONData(String)
Extracts data from specified page ranges as JSON string.
Public methodGetJSONData(Int32, Int32)
Extracts data from specified page range as JSON string.
Public methodSaveJSONToFile(String)
Saves extracted data to file in JSON format.
Public methodSaveJSONToFile(IListInt32, String)
Saves extracted data from specified pages to file in JSON format.
Public methodSaveJSONToFile(Int32, String)
Saves extracted data from specified page to file in JSON format.
Public methodSaveJSONToFile(String, String)
Saves extracted data from specified page ranges to file in JSON format.
Public methodSaveJSONToFile(Int32, Int32, String)
Saves extracted data from specified page range to file in JSON format.
Public methodSaveJSONToStream(Stream)
Saves extracted data to stream in JSON format.
Public methodSaveJSONToStream(IListInt32, Stream)
Saves extracted data from specified pages to stream in JSON format.
Public methodSaveJSONToStream(Int32, Stream)
Saves extracted data from specified page to stream in JSON format.
Public methodSaveJSONToStream(String, Stream)
Saves extracted data from specified page ranges to stream in JSON format.
Public methodSaveJSONToStream(Int32, Int32, Stream)
Saves extracted data from specified page range to stream in JSON format.
Top
See Also

Reference