Kofax.OmniPageCSDK.IproPlus Namespace

A single zone or a collection of zones created during the preprocessing Load and Scan processes that the OCR Engine senses as possible area(s) for recognition.

Collection of BackgroundZone objects.

The BarcodeType object contains information about the particular bar code type.

The BarcodeTypes collection is a sorted set of BarcodeType objects. Each element represents a recognizable bar code type.

The Character object provides information about a single recognized character, such as the character code, coordinates of the character on the image, confidence information etc.

The Characters collection is a sorted set of Character objects, where each element represents a single character in the recognition result.

The Converter object provides properties and methods to customize the layout of the output files created by the Document and Page objects' ConvertResult method.

This object represents an enum value of a ConverterEnumValues collection.

This collection contains the available enum values of a ConverterProperty object.

This object represents a single converter setting.

The Converters collection is a sorted set of output Converter objects.

The Document object represents an IPRO document which encapsulates the data and the parameters required during OCR-related procedures.

The Documents collection is a sorted set of Document objects, where each element represents a document handled by the Engine.

Returns the Engine object.

Special constants that can be used in the Document object's GetFindText method.

This property returns the image.

The ImageFile object represents an image file in the file system.

This property returns the ImageFiles collection, which enumerates the set of images loaded from physical files, in order to apply image transformation and manipulation algorithms.

This property returns a reference to the ImageInfo object which contains information about the image.

Constants.

The role of the Link object is to provide workflows with loading sources and saving targets that are not present on the local computer.

This method returns the links collection.

The MemoryBitmap object represents an image stored in the memory.

This property returns the MemoryBitmaps collection, which enumerates the set of bitmaps stored in the memory.

The ModuleInfo object contains information about a specific module of the Engine.

This property returns the ModuleInfos collection, which contains information about the available modules in the current engine configuration.

The OCRZone object contains information about a specific OCR zone on a page.

This property returns the collection of zones, which were created by the engine during zone location.

Specifies the index of the page that contains the found text.

This property returns the Pages collection, containing the document Page objects.

The RecognitionLanguage object contains information about a given recognition language.

This property returns the collection of available recognition languages that can be switched on/off independently.

The RemovedLine object represents a line that was removed from the BW version of the original image. This object provides access to the position and orientation of the line.

The RemovedLines collection is a set of RemovedLine objects representing the lines that were removed from the related BW image. The RemoveLines method of the Page object returns this collection.

Scanner objects represent a physical scanner.

This property returns the Scanners collection of the engine, which enumerates all available scanners. If the Engine is not initialized, accessing this property raises a trappable error.

The role of the SearchText object is to support parameterized text searches (such as finding whole words only, searching with case matching, searching from the beginning or the end of the document etc.), navigating through results and processing them using the text marking and redaction facilities.

This property returns the SettingManager object, which allows you to manage your application-specific settings together with the Engine settings in a thread-safe manner.

The SettingNode object provides access to a particular node and its setting if it exists.

Use this property to get or set the spelling language for document level spell checking.

This property returns the SpellLanguages collection, which enumerates the Spelling languages available in the current engine configuration, i.e. those for which a Language dictionary is installed and present in the engine binary directory.

This property returns the Statistics object of the document.

The TableCell object represents a single cell in a table.

This method returns the collection of TableCell objects for a WT_TABLE zone.

The UDItem object contains information about a specific item associated with a particular User Dictionary. See UDSection.

This property returns the UDItems collection of the UDSection object.

This property returns the UDManager object, used to maintain user dictionaries.

The UDSection object represents a user dictionary section.

This property returns the UDSections collection of the active user dictionary.

The UILanguage object contains information about a specific Visual Toolbox User Interface language.

This property returns the UILanguages collection, which enumerates the available Visual Toolbox User Interface languages.

The UserZone object contains information about a particular user zone on the page.

This property returns the collection of zones created by the user. These will be used during recognition.

This property returns the collection of available vertical (professional) dictionaries.

The VerticalDictionary object contains the name and description of one vertical dictionary.

Use this property to acquire the workflow static information provider interface.

This property returns the workflow handler interface.

This property returns the list of available workflow handler options.

Info tags are generated during workflow execution, they have three types: info, error and warning. Each tag describes a occured event in detail. Errors resulting during workflow execution can be detected by these info tags.

Use this method to regulate how the workflow steps communicate with the user during processing.

This property returns a specific workflow object.

Use this method to return the object collection of a specific workflow.

Use this property to acquire the workflow dynamic / runtime information provider interface.

Object without methods, can only fire events from workflow progress.

This property returns a specific workflow step.

Workflow step flags.

In IPRO, you can set workflow step parameters.

Use this method to return the step collection of a specific workflow.

This structure provides information on the text found and its environment. The FindTextContext structure is filled by the Text method of the SearchText object.

This is a recognized data structure.

This structure represents a bordered box or a rectangular frame together with its visual properties as detected during recognition.

This structure represents an image pixel coordinate.

This structure represents a rectangle with the top-left corner and its dimensions.

This structure represents a size, usually the size of a rectangle.

Structure describing the result of preprocessing. See ImagePreprocess and PreprocessInfo.

Page sizes supported by the scanner.See SupportedPapers.

Returns all named parameters of a step. See Parameters.

Active document mode.

Reference point of the anchor.

Content of the anchor zone.

Flags of anchor zones.

Type of anchor zone.

Barcode types.

Basic character set types of languages.

Custom data types.

Table cell border styles.

Cell mapping values.

Deprecated. This functionality is no longer supported in CSDK19. It will be removed from the next version of the CSDK.

Recognition filters.

Comb attributes.

Continent ID.

Export file options.

Export formatting levels.

Export page ranges.

Export timestamp options.

Despeckling types.

Startup paths for load and save dialogs.

Document formatter methods.

Documentum property types.

DTXT output formats.

Type of neighborhood used at erosion and dilatation.

Determining the area to be filled.

Filling methods.

Search text action flags.

Find text flags.

Obsolete.

Obsolete.

Obsolete.

Obsolete.

Writing style of HNR.

Index of each image type in the Page object.

The supported image formats.

Image quality (for DTXT PDF output).

MRC level (for DTXT PDF output).

PDF compatibility for saving PDF with DTXT_PDFIOT

PDF files may be saved with different encryption types.

Image conversion types.

Page parse method.

Image deskewing mode.

Image flags.

Image inversion mode.

Image line order.

Image padding.

Image resolution enhancement.

Image color order.

Available image transformations (rotation and/or mirroring).

Image stretching mode.

User dictionary item types.

Workflow type enumerations.

Generic constants.

Module identifiers.

Possible languages.

Every link which is not load, scan, load ODP, and save ODP or export; SharePoint, FTP, etc.

Module status constants for ModuleInfo objects.

Describes the position of a new page inserted into the document.

Frame detection methods for RM_OMR.

Mark sensitivity of RM_OMR.

Possible page layout values for workflow execution.

Describes page state during recognition process.

PDF processing mode.

PDF recognition mode.

Flags for the structure PREPROCINFO.

Processing Mode.

Controls whether proofreading is done along with editing or not.

Describes specified property categories according to distinct groupings.

Describes property types.

HeadersFooters. You can set how headers and footers should be handled. You can set it for every converter, but the default value is different.

PageBreaks. For several converters you can set how you want page breaks to be handled.

Picture color. For several converters, you can set the color of the image.

Pictures. For every converter you can set how you would like to handle images. The default values are different for the various converters.

Tables. For every converter, except the Excel and Html converters, you can set how you would like to handle tables.

Describes possible error types.

Recognition modules.

Reference anchor mode.

Retain color.

Possible types of lines.

Recognition modules supporting a language

Trade-off setting.

Application flags.

ADF/transparency adapter status.

Getting duplex scanning capabilities.

Getting scanning mode capabilities.

Getting dropout color capabilities.

Getting orientation capabilities.

Orientation of paper.

Standard paper sizes.

Getting paper source capabilities.

Scanner resolutions.

Starting modes of the scanner.

Scanner Wizard flags.

Describes types of pages to be processed. See ImagePreprocess, LocateZones, SaveImages, ApplyFormTemplate.

Default directory location of the scanner configuration file.

Flags of settings.

Type ID's of settings.

Color quality. For the PDF converters you can set the color quality. The default is R2ID_PDFCOLORQUALITY_MIN for every PDF converter.

MRC use. For PDF converters you can set the MRC type. The default is: R2ID_PDFMRC_NO for every PDF converter.

Compatibility. For the PDF converters you can set this compatibility value.

PDFSecurity type. For PDF converters you can set the security type.

Signature type. For the PDF converters you can set the signature type. The default is: R2ID_SIGTYPENONE for every PDF converter.

Index Page. You can switch on the Index Page generation in simple or 'InFrame' mode using HTML output converters. If it is switched on, an index page is generated with links to the recognized and converted pages. In this case, you can change the text of the navigation links by changing NavNextText, NavPrevText or NavTOCText.

User dictionary saving styles.

If the workflow gets into interactive mode (see OnEnterInteractiveMode), then it can be offset from the interactive mode programatically with the help of the UIStepIntervention method, but it must be stated how the workflow is to continue.

Describes state of workflow execution.

The origin of WFHandler's current workflow, i.e. whether it was created by LoadWF or CreateWF.

Description of workflow processing modes.

Describes severity level types.

Describes workflow steps throughout the recognition process.

Basic zone types.