DocumentParser Methods
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
The DocumentParser type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AddTemplate(String) | Loads template from YAML or JSON file and adds it to internal template list. File can contain a single template or several templates as array. Multiple YAML templates can also be separated by "---" line instead of array. |
| AddTemplate(Template) | |
| AddTemplateFromString(String) | Loads template from YAML or JSON string and adds it to internal template list. String can contain a single template or several templates as array. Multiple YAML templates can also be separated by "---" line instead of array. |
| AddTemplateFromString(String, String) | Loads template from YAML or JSON string and adds it to internal template list. String can contain a single template or several templates as array. Multiple YAML templates can also be separated by "---" line instead of array. |
| AddTemplates | Loads templates from specified folder (and its subfolders) to internal template list. Template files must have ".yml" or ".json" extension. |
| ClearTemplates | Removes all loaded templates. |
| Dispose | Releases managed resources of the component. |
| Equals | (Inherited from Object.) |
 | ExportResultsToCSV | Exports parsing results to CSV format. |
| ExportResultsToJSON | Exports parsing results to JSON format. |
| ExportResultsToXML | Exports parsing results to XML format. |
| ExportResultsToYAML | Exports parsing results to YAML format. |
 | Finalize | (Inherited from Object.) |
| GetCashedDocumentText | Returns text of the document that is parsed with most recent template. Available only in the FULL version. TRIAL version returns empty string. |
| GetDocumentText(Stream, Int32) | Extracts text from a page or entire document. You can use it for template composing and testing. |
| GetDocumentText(String, Int32) | Extracts text from a page or entire document. You can use it for template composing and testing. |
| GetDocumentText(Stream, Stream, Int32) | Extracts text from a page or entire document. You can use it for template composing and testing. |
| GetDocumentText(String, String, Int32) | Extracts text from a page or entire document. You can use it for template composing and testing. |
| GetHashCode | (Inherited from Object.) |
| GetPageCount(Stream) | Returns count of pages in PDF or TIFF document. |
| GetPageCount(String) | Returns count of pages in PDF or TIFF document. |
| GetType | (Inherited from Object.) |
| Log | |
| MemberwiseClone | (Inherited from Object.) |
| ParseDocument(Stream) | Process a document using loaded templates. |
| ParseDocument(String) | Process a document using loaded templates. |
| ParseDocument(Stream, OutputFormat, CSVOptions) | Parse document. |
| ParseDocument(String, OutputFormat, CSVOptions) | Parse document. |
| ParseDocument(Stream, Stream, OutputFormat, CSVOptions) | Process document. |
| ParseDocument(String, String, OutputFormat, CSVOptions) | Process document. |
| ParseDocumentPageRange(Stream, IListInt32) | Process a part of the document using loaded templates. |
| ParseDocumentPageRange(Stream, String) | Process a part of the document using loaded templates. |
| ParseDocumentPageRange(String, IListInt32) | Process a part of the document using loaded templates. |
| ParseDocumentPageRange(String, String) | Process a part of the document using loaded templates. |
| ParseDocumentPageRange(Stream, Int32, Int32) | Process a part of the document using loaded templates. |
| ParseDocumentPageRange(String, Int32, Int32) | Process a part of the document using loaded templates. |
| ParseDocumentPageRange(Stream, IListInt32, OutputFormat, CSVOptions) | Process a part of the document. |
| ParseDocumentPageRange(Stream, String, OutputFormat, CSVOptions) | Process a part of the document. |
| ParseDocumentPageRange(String, IListInt32, OutputFormat, CSVOptions) | Process a part of the document. |
| ParseDocumentPageRange(String, String, OutputFormat, CSVOptions) | Process a part of the document. |
| ParseDocumentPageRange(Stream, IListInt32, Stream, OutputFormat, CSVOptions) | Process a part of the document. |
| ParseDocumentPageRange(Stream, Int32, Int32, OutputFormat, CSVOptions) | Process a part of the document. |
| ParseDocumentPageRange(Stream, String, Stream, OutputFormat, CSVOptions) | Process a part of the document. |
| ParseDocumentPageRange(String, IListInt32, String, OutputFormat, CSVOptions) | Process a part of the document. |
| ParseDocumentPageRange(String, Int32, Int32, OutputFormat, CSVOptions) | Process a part of the document. |
| ParseDocumentPageRange(String, String, String, OutputFormat, CSVOptions) | Process a part of the document. |
| ParseDocumentPageRange(Stream, Int32, Int32, Stream, OutputFormat, CSVOptions) | Process a part of the document. |
| ParseDocumentPageRange(String, Int32, Int32, String, OutputFormat, CSVOptions) | Process a part of the document. |
| ToString | (Inherited from Object.) |
See Also