DocumentParser MethodsByteScout Document Parser SDK

The DocumentParser type exposes the following members.

Methods

  NameDescription
Public methodAddTemplate(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.
Public methodAddTemplate(Template)
Public methodAddTemplateFromString(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.
Public methodAddTemplateFromString(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.
Public methodAddTemplates
Loads templates from specified folder (and its subfolders) to internal template list. Template files must have ".yml" or ".json" extension.
Public methodClearTemplates
Removes all loaded templates.
Public methodDispose
Releases managed resources of the component.
Public methodEquals (Inherited from Object.)
Public methodStatic memberExportResultsToCSV
Exports parsing results to CSV format.
Public methodStatic memberExportResultsToJSON
Exports parsing results to JSON format.
Public methodStatic memberExportResultsToXML
Exports parsing results to XML format.
Public methodStatic memberExportResultsToYAML
Exports parsing results to YAML format.
Protected methodFinalize (Inherited from Object.)
Public methodGetCashedDocumentText
Returns text of the document that is parsed with most recent template. Available only in the FULL version. TRIAL version returns empty string.
Public methodGetDocumentText(Stream, Int32)
Extracts text from a page or entire document. You can use it for template composing and testing.
Public methodGetDocumentText(String, Int32)
Extracts text from a page or entire document. You can use it for template composing and testing.
Public methodGetDocumentText(Stream, Stream, Int32)
Extracts text from a page or entire document. You can use it for template composing and testing.
Public methodGetDocumentText(String, String, Int32)
Extracts text from a page or entire document. You can use it for template composing and testing.
Public methodGetHashCode (Inherited from Object.)
Public methodGetPageCount(Stream)
Returns count of pages in PDF or TIFF document.
Public methodGetPageCount(String)
Returns count of pages in PDF or TIFF document.
Public methodGetType (Inherited from Object.)
Protected methodLog
Protected methodMemberwiseClone (Inherited from Object.)
Public methodParseDocument(Stream)
Process a document using loaded templates.
Public methodParseDocument(String)
Process a document using loaded templates.
Public methodParseDocument(Stream, OutputFormat, CSVOptions)
Parse document.
Public methodParseDocument(String, OutputFormat, CSVOptions)
Parse document.
Public methodParseDocument(Stream, Stream, OutputFormat, CSVOptions)
Process document.
Public methodParseDocument(String, String, OutputFormat, CSVOptions)
Process document.
Public methodParseDocumentPageRange(Stream, IListInt32)
Process a part of the document using loaded templates.
Public methodParseDocumentPageRange(Stream, String)
Process a part of the document using loaded templates.
Public methodParseDocumentPageRange(String, IListInt32)
Process a part of the document using loaded templates.
Public methodParseDocumentPageRange(String, String)
Process a part of the document using loaded templates.
Public methodParseDocumentPageRange(Stream, Int32, Int32)
Process a part of the document using loaded templates.
Public methodParseDocumentPageRange(String, Int32, Int32)
Process a part of the document using loaded templates.
Public methodParseDocumentPageRange(Stream, IListInt32, OutputFormat, CSVOptions)
Process a part of the document.
Public methodParseDocumentPageRange(Stream, String, OutputFormat, CSVOptions)
Process a part of the document.
Public methodParseDocumentPageRange(String, IListInt32, OutputFormat, CSVOptions)
Process a part of the document.
Public methodParseDocumentPageRange(String, String, OutputFormat, CSVOptions)
Process a part of the document.
Public methodParseDocumentPageRange(Stream, IListInt32, Stream, OutputFormat, CSVOptions)
Process a part of the document.
Public methodParseDocumentPageRange(Stream, Int32, Int32, OutputFormat, CSVOptions)
Process a part of the document.
Public methodParseDocumentPageRange(Stream, String, Stream, OutputFormat, CSVOptions)
Process a part of the document.
Public methodParseDocumentPageRange(String, IListInt32, String, OutputFormat, CSVOptions)
Process a part of the document.
Public methodParseDocumentPageRange(String, Int32, Int32, OutputFormat, CSVOptions)
Process a part of the document.
Public methodParseDocumentPageRange(String, String, String, OutputFormat, CSVOptions)
Process a part of the document.
Public methodParseDocumentPageRange(Stream, Int32, Int32, Stream, OutputFormat, CSVOptions)
Process a part of the document.
Public methodParseDocumentPageRange(String, Int32, Int32, String, OutputFormat, CSVOptions)
Process a part of the document.
Public methodToString (Inherited from Object.)
Top
See Also

Reference