| AspriseOCR Class |
» Asprise OCR Home · Developer's Guide
Represents an Asprise OCR engine.
Read the developer's guide here.
Inheritance HierarchyNamespace: asprise_ocr_api
Assembly: asprise-ocr-api (in asprise-ocr-api.dll) Version: 15.3.1.0 (15.3.1.0)
SyntaxThe AspriseOCR type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AspriseOCR | Initializes a new instance of the AspriseOCR class |
Properties| Name | Description | |
|---|---|---|
 | IsEngineRunning |
Whether the OCR engine is currently running.
|
Methods| Name | Description | |
|---|---|---|
 | addToSystemPath |
Adds the given directory to the PATH variable.
|
| dictToString | |
| GetLibraryVersion |
The library version.
|
| getOcrDllName |
The simple name of the ocr dll file.
|
| InputLicense | Input the license code |
| isEmpty | return true if the given string is null or of lenght 0. |
| ListSupportedLangs |
Call this after setup is done; returns list of langs separated by ','
|
| loadDll | Finds the OCR dll in system path or from bundle and return the path to the dll. |
| Recognize(IListBitmap, Int32, Int32, Int32, Int32, String, String, Object) |
Performs OCR on the given input bitmaps.
|
| Recognize(String, Int32, Int32, Int32, Int32, Int32, String, String, Object) |
Performs OCR on the given input files.
|
| saveAocrXslTo | save the aocr.xsl to the specified directory |
| SetUp |
Performs one-time setup; does nothing if setup has already been done.
|
| StartEngine |
Starts the OCR engine; does nothing if the engine has already been started.
|
| StopEngine |
Stops the OCR engine; does nothing if it has already been stopped.
|
Fields| Name | Description | |
|---|---|---|
 | CONFIG_PROP_KEY_VALUE_SEPARATOR | Do not change unless you are told so. |
| CONFIG_PROP_SEPARATOR | Do not change unless you are told so. |
| LANGUAGE_DEU | deu (German) |
| LANGUAGE_ENG | eng (English) |
| LANGUAGE_FRA | fra (French) |
| LANGUAGE_POR | por (Portuguese) |
| LANGUAGE_SPA | spa (Spanish) |
| OUTPUT_FORMAT_PDF | Output recognition result as searchable PDF |
| OUTPUT_FORMAT_PLAINTEXT | Output recognition result as plain text |
| OUTPUT_FORMAT_RTF | Output to editable format RTF (can be edited in MS Word) |
| OUTPUT_FORMAT_XML | Output recognition result in XML format with additional information if coordination, confidence, runtime, etc. |
| PAGES_ALL | Recognize all pages. |
| PROP_DICT_DICT_IMPORTANCE | Percentage measuring the importance of the dictionary (0: not at all; 100: extremely important; default: 10) |
| PROP_IMG_PREPROCESS_CUSTOM_CMDS | Custom mage pre-processing command |
| PROP_IMG_PREPROCESS_TYPE | Image pre-processing type |
| PROP_IMG_PREPROCESS_TYPE_CUSTOM | Custom, need to set PROP_IMG_PREPROCESS_CUSTOM_CMDS |
| PROP_IMG_PREPROCESS_TYPE_DEFAULT | Use system default |
| PROP_IMG_PREPROCESS_TYPE_DEFAULT_WITH_ORIENTATION_DETECTION | Default + page orientation detection |
| PROP_INPUT_PDF_DPI | The DPI to be used to render the PDF file; default is 300 if not specified |
| PROP_LIMIT_TO_CHARSET | Limit charset to a set of predefined chars |
| PROP_OUTPUT_SEPARATE_WORDS | Set to 'true' to set the output level as word instead of the default, line. |
| PROP_PAGE_TYPE | Page type |
| PROP_PAGE_TYPE_AUTO_DETECT | Page type value: auto |
| PROP_PAGE_TYPE_SCATTERED | Page type value: scattered text |
| PROP_PAGE_TYPE_SINGLE_BLOCK | Page type value: a single block of text |
| PROP_PAGE_TYPE_SINGLE_CHARACTOR | Page type value: a single char |
| PROP_PAGE_TYPE_SINGLE_COLUMN | Page type value: a single column of text |
| PROP_PAGE_TYPE_SINGLE_LINE | Page type value: a single line of text |
| PROP_PAGE_TYPE_SINGLE_WORD | Page type value: a single word |
| PROP_PDF_OUTPUT_FILE | PDF output file - required for PDF output. Valid prop value: absolute path to the target output file. |
| PROP_PDF_OUTPUT_FONT | Font to be used for PDF output. Optional. Valid values: "serif" (default), "sans". |
| PROP_PDF_OUTPUT_IMAGE_DPI | The DPI of the images or '0' to auto-detect. Optional. Valid prop value: 0(default: auto-detect), 300, 200, etc. |
| PROP_PDF_OUTPUT_IMAGE_FORCE_BW | Convert images into black/white to reduce PDF output file size. Optional. Valid prop values: false(default), true. |
| PROP_PDF_OUTPUT_PDFA | Set to true to output PDF/A instead of normal PDF. |
| PROP_PDF_OUTPUT_PDFA_FONT_FILE | Optionally specifies path to the custom font to be embedded in PDF/A |
| PROP_PDF_OUTPUT_RETURN_TEXT | Set to 'text' or 'xml' to return information when the output format is PDF |
| PROP_PDF_OUTPUT_RETURN_TEXT_FORMAT_PLAINTEXT | Return text |
| PROP_PDF_OUTPUT_RETURN_TEXT_FORMAT_XML | Return xml |
| PROP_PDF_OUTPUT_TEXT_VISIBLE | Make text visible - for debugging and analysis purpose. Optional. Valid prop values false(default), true. |
| PROP_RTF_OUTPUT_FILE | RTF output file - required for RTF output. Valid prop value: absolute path to the target output file. |
| PROP_RTF_OUTPUT_RETURN_TEXT | Return text in 'text' or 'xml' format when the output format is set to RTF. |
| PROP_RTF_OUTPUT_RETURN_TEXT_FORMAT_PLAINTEXT | Return text |
| PROP_RTF_OUTPUT_RETURN_TEXT_FORMAT_XML | Return xml |
| PROP_RTF_PAPER_SIZE | default is LETTER, may set to A4. |
| PROP_SAVE_INTERMEDIATE_IMAGES_TO_DIR | Save intermediate images generated for debug purpose - don't specify or empty string to skip saving |
| PROP_TABLE_MIN_SIDE_LENGTH | default is 31 if not specified |
| PROP_TABLE_SKIP_DETECTION | table will be detected by default; set this property to true to skip detection. |
| RECOGNIZE_TYPE_ALL | Recognize both text and barcode |
| RECOGNIZE_TYPE_BARCODE | Recognize barcode |
| RECOGNIZE_TYPE_TEXT | Recognize text |
| SPEED_FAST | less speed, better accuracy |
| SPEED_FASTEST | Highest speed, accuracy may suffer - default option |
| SPEED_SLOW | lowest speed, best accuracy |
| START_PROP_DICT_CUSTOM_DICT_FILE | Path to your custom dictionary (words are separated using line breaks). Default value: null. - can only be used for StartEngine |
| START_PROP_DICT_CUSTOM_TEMPLATES_FILE | Path to your custom templates (templates are separated using line breaks). Default value: null. - can only be used for StartEngine |
| START_PROP_DICT_SKIP_BUILT_IN_ALL | set to 'true' to skip using all built-in dicts. Default value: 'false' - can only be used for StartEngine |
| START_PROP_DICT_SKIP_BUILT_IN_DEFAULT | set to 'true' to skip using the default built in dict. Default value: 'false' - can only be used for StartEngine |
See Also