Click or drag to resize
AspriseOCR Class

» Asprise OCR Home · Developer's Guide

Represents an Asprise OCR engine. Read the developer's guide here.
Inheritance Hierarchy
SystemObject
  asprise_ocr_apiAspriseOCR

Namespace: asprise_ocr_api
Assembly: asprise-ocr-api (in asprise-ocr-api.dll) Version: 15.3.1.0 (15.3.1.0)
Syntax
public class AspriseOCR

The AspriseOCR type exposes the following members.

Constructors
  NameDescription
Public methodAspriseOCR
Initializes a new instance of the AspriseOCR class
Top
Properties
  NameDescription
Public propertyIsEngineRunning
Whether the OCR engine is currently running.
Top
Methods
  NameDescription
Public methodStatic memberaddToSystemPath
Adds the given directory to the PATH variable.
Public methodStatic memberdictToString
Public methodStatic memberGetLibraryVersion
The library version.
Public methodStatic membergetOcrDllName
The simple name of the ocr dll file.
Public methodStatic memberInputLicense
Input the license code
Public methodStatic memberisEmpty
return true if the given string is null or of lenght 0.
Public methodStatic memberListSupportedLangs
Call this after setup is done; returns list of langs separated by ','
Public methodStatic memberloadDll
Finds the OCR dll in system path or from bundle and return the path to the dll.
Public methodRecognize(IListBitmap, Int32, Int32, Int32, Int32, String, String, Object)
Performs OCR on the given input bitmaps.
Public methodRecognize(String, Int32, Int32, Int32, Int32, Int32, String, String, Object)
Performs OCR on the given input files.
Public methodStatic membersaveAocrXslTo
save the aocr.xsl to the specified directory
Public methodStatic memberSetUp
Performs one-time setup; does nothing if setup has already been done.
Public methodStartEngine
Starts the OCR engine; does nothing if the engine has already been started.
Public methodStopEngine
Stops the OCR engine; does nothing if it has already been stopped.
Top
Fields
  NameDescription
Public fieldStatic memberCONFIG_PROP_KEY_VALUE_SEPARATOR
Do not change unless you are told so.
Public fieldStatic memberCONFIG_PROP_SEPARATOR
Do not change unless you are told so.
Public fieldStatic memberLANGUAGE_DEU
deu (German)
Public fieldStatic memberLANGUAGE_ENG
eng (English)
Public fieldStatic memberLANGUAGE_FRA
fra (French)
Public fieldStatic memberLANGUAGE_POR
por (Portuguese)
Public fieldStatic memberLANGUAGE_SPA
spa (Spanish)
Public fieldStatic memberOUTPUT_FORMAT_PDF
Output recognition result as searchable PDF
Public fieldStatic memberOUTPUT_FORMAT_PLAINTEXT
Output recognition result as plain text
Public fieldStatic memberOUTPUT_FORMAT_RTF
Output to editable format RTF (can be edited in MS Word)
Public fieldStatic memberOUTPUT_FORMAT_XML
Output recognition result in XML format with additional information if coordination, confidence, runtime, etc.
Public fieldStatic memberPAGES_ALL
Recognize all pages.
Public fieldStatic memberPROP_DICT_DICT_IMPORTANCE
Percentage measuring the importance of the dictionary (0: not at all; 100: extremely important; default: 10)
Public fieldStatic memberPROP_IMG_PREPROCESS_CUSTOM_CMDS
Custom mage pre-processing command
Public fieldStatic memberPROP_IMG_PREPROCESS_TYPE
Image pre-processing type
Public fieldStatic memberPROP_IMG_PREPROCESS_TYPE_CUSTOM
Custom, need to set PROP_IMG_PREPROCESS_CUSTOM_CMDS
Public fieldStatic memberPROP_IMG_PREPROCESS_TYPE_DEFAULT
Use system default
Public fieldStatic memberPROP_IMG_PREPROCESS_TYPE_DEFAULT_WITH_ORIENTATION_DETECTION
Default + page orientation detection
Public fieldStatic memberPROP_INPUT_PDF_DPI
The DPI to be used to render the PDF file; default is 300 if not specified
Public fieldStatic memberPROP_LIMIT_TO_CHARSET
Limit charset to a set of predefined chars
Public fieldStatic memberPROP_OUTPUT_SEPARATE_WORDS
Set to 'true' to set the output level as word instead of the default, line.
Public fieldStatic memberPROP_PAGE_TYPE
Page type
Public fieldStatic memberPROP_PAGE_TYPE_AUTO_DETECT
Page type value: auto
Public fieldStatic memberPROP_PAGE_TYPE_SCATTERED
Page type value: scattered text
Public fieldStatic memberPROP_PAGE_TYPE_SINGLE_BLOCK
Page type value: a single block of text
Public fieldStatic memberPROP_PAGE_TYPE_SINGLE_CHARACTOR
Page type value: a single char
Public fieldStatic memberPROP_PAGE_TYPE_SINGLE_COLUMN
Page type value: a single column of text
Public fieldStatic memberPROP_PAGE_TYPE_SINGLE_LINE
Page type value: a single line of text
Public fieldStatic memberPROP_PAGE_TYPE_SINGLE_WORD
Page type value: a single word
Public fieldStatic memberPROP_PDF_OUTPUT_FILE
PDF output file - required for PDF output. Valid prop value: absolute path to the target output file.
Public fieldStatic memberPROP_PDF_OUTPUT_FONT
Font to be used for PDF output. Optional. Valid values: "serif" (default), "sans".
Public fieldStatic memberPROP_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.
Public fieldStatic memberPROP_PDF_OUTPUT_IMAGE_FORCE_BW
Convert images into black/white to reduce PDF output file size. Optional. Valid prop values: false(default), true.
Public fieldStatic memberPROP_PDF_OUTPUT_PDFA
Set to true to output PDF/A instead of normal PDF.
Public fieldStatic memberPROP_PDF_OUTPUT_PDFA_FONT_FILE
Optionally specifies path to the custom font to be embedded in PDF/A
Public fieldStatic memberPROP_PDF_OUTPUT_RETURN_TEXT
Set to 'text' or 'xml' to return information when the output format is PDF
Public fieldStatic memberPROP_PDF_OUTPUT_RETURN_TEXT_FORMAT_PLAINTEXT
Return text
Public fieldStatic memberPROP_PDF_OUTPUT_RETURN_TEXT_FORMAT_XML
Return xml
Public fieldStatic memberPROP_PDF_OUTPUT_TEXT_VISIBLE
Make text visible - for debugging and analysis purpose. Optional. Valid prop values false(default), true.
Public fieldStatic memberPROP_RTF_OUTPUT_FILE
RTF output file - required for RTF output. Valid prop value: absolute path to the target output file.
Public fieldStatic memberPROP_RTF_OUTPUT_RETURN_TEXT
Return text in 'text' or 'xml' format when the output format is set to RTF.
Public fieldStatic memberPROP_RTF_OUTPUT_RETURN_TEXT_FORMAT_PLAINTEXT
Return text
Public fieldStatic memberPROP_RTF_OUTPUT_RETURN_TEXT_FORMAT_XML
Return xml
Public fieldStatic memberPROP_RTF_PAPER_SIZE
default is LETTER, may set to A4.
Public fieldStatic memberPROP_SAVE_INTERMEDIATE_IMAGES_TO_DIR
Save intermediate images generated for debug purpose - don't specify or empty string to skip saving
Public fieldStatic memberPROP_TABLE_MIN_SIDE_LENGTH
default is 31 if not specified
Public fieldStatic memberPROP_TABLE_SKIP_DETECTION
table will be detected by default; set this property to true to skip detection.
Public fieldStatic memberRECOGNIZE_TYPE_ALL
Recognize both text and barcode
Public fieldStatic memberRECOGNIZE_TYPE_BARCODE
Recognize barcode
Public fieldStatic memberRECOGNIZE_TYPE_TEXT
Recognize text
Public fieldStatic memberSPEED_FAST
less speed, better accuracy
Public fieldStatic memberSPEED_FASTEST
Highest speed, accuracy may suffer - default option
Public fieldStatic memberSPEED_SLOW
lowest speed, best accuracy
Public fieldStatic memberSTART_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
Public fieldStatic memberSTART_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
Public fieldStatic memberSTART_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
Public fieldStatic memberSTART_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
Top
See Also