IJSONExtractor Interface
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
Defines the PDF to JSON extractor interface.
Namespace:Bytescout.PDFExtractorAssembly: Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 13.4.0.4760-master
Syntax
The IJSONExtractor type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AllowStandalonePunctuation | Gets or sets whether to allow standalone punctuation characters. If false they will be merged with nearest text object. |
| CleanJSON | Get or sets whether to generate regular JSON with camel-cased object identifiers without '@' (attribute) and '#' (node content) marks. Default is true. |
| DetectStrikeoutTextStyle | Get or sets whether to detect the "strikeout" text style. Default is false. |
| DetectUnderlineTextStyle | Get or sets whether to detect the "underline" text style. Default is false. |
| ImageFolder | 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. |
| ImageFormat | Gets or sets the image format for extracted images. Default is PNG. |
| IndentedJSON | Get or sets whether to generate indented JSON. Default is true. |
| KeepOriginalFontNames | 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. |
| OutputStructure | Gets or sets the structure of output JSON data. |
| OutputTransformation | Gets or sets JSONPath ("XPath for JSON") expression that you can use to transform the output JSON. |
| SaveImages | 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. |
| SaveVectors | Get or sets whether to save vector objects. Default is false. |
Methods
| Name | Description | |
|---|---|---|
 | GetJSONAsVariant | 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. |
| GetJSONAsVariant(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. |
| GetJSONAsVariant(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. |
| GetJSONData | Extracts data from whole document as JSON string. |
| GetJSONData(IListInt32) | Extracts data from specified pages as JSON string. |
| GetJSONData(Int32) | Extracts data from specified document page as JSON string. |
| GetJSONData(String) | Extracts data from specified page ranges as JSON string. |
| GetJSONData(Int32, Int32) | Extracts data from specified page range as JSON string. |
| SaveJSONToFile(String) | Saves extracted data to file in JSON format. |
| SaveJSONToFile(IListInt32, String) | Saves extracted data from specified pages to file in JSON format. |
| SaveJSONToFile(Int32, String) | Saves extracted data from specified page to file in JSON format. |
| SaveJSONToFile(String, String) | Saves extracted data from specified page ranges to file in JSON format. |
| SaveJSONToFile(Int32, Int32, String) | Saves extracted data from specified page range to file in JSON format. |
| SaveJSONToStream(Stream) | Saves extracted data to stream in JSON format. |
| SaveJSONToStream(IListInt32, Stream) | Saves extracted data from specified pages to stream in JSON format. |
| SaveJSONToStream(Int32, Stream) | Saves extracted data from specified page to stream in JSON format. |
| SaveJSONToStream(String, Stream) | Saves extracted data from specified page ranges to stream in JSON format. |
| SaveJSONToStream(Int32, Int32, Stream) | Saves extracted data from specified page range to stream in JSON format. |
See Also