UserZone Class

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

Inheritance Hierarchy

System.Object
Kofax.OmniPageCSDK.IproPlus.IproPlusClass
Kofax.OmniPageCSDK.IproPlus.UserZone

Namespace: Kofax.OmniPageCSDK.IproPlus
Assembly: Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0

Syntax

C++

Copy

public class UserZone : IproPlusClass, IDisposable

Public Class UserZone
	Inherits IproPlusClass
	Implements IDisposable

public ref class UserZone : public IproPlusClass, 
	IDisposable

The UserZone type exposes the following members.

Properties

	Name	Description
	BoundingRect	This property specifies the location of a user zone on the page.
	CheckFullLines	Use this property to get or set whether the recognition module associated with this user zone will pass entire lines to the checking subsystem and the Check event of the Document object instead of words.
	CorrectProperNames	Use this property to get or set whether the correction feature of the checking subsystem will capitalize names (proper nouns) inside recognized text.
	DisableCorrection	Use this property to get or set whether or not to prohibit the correction feature of the checking subsystem for this user zone.
	DisableSpellLangDict	Use this property to get or set whether the checking subsystem uses the currently set language dictionary for this user zone.
	DisableUserCheck	Use this property to get or set whether the Check event of the Document object is fired during recognition of this UserZone object.
	DisableUserDict	Use this property to get or set whether the checking subsystem uses the currently set user dictionary for this user zone.
	DisableVerticalDict	Use this property to get or set whether the checking subsystem uses the currently set vertical (professional) dictionary for this user zone.
	Filter	This property can be used to get or set a character set filter for the user zone.
	FormFieldName	This property returns the field name provided by the Logical Form Recognition process if available or the modified value if it was previously altered through the FormFieldName property.
	IgnoreCase	Use this property to get or set whether or not the checking subsystem uses the currently set user dictionary in case-sensitive mode.
	IgnoreWhiteSpace	Use this property to get or set whether or not the white space characters (SPACE and TAB characters) are ignored during checking for this user zone.
	IncludePunctuation	Use this property to get or set whether checking will include punctuation characters on the verified string boundaries.
	Module	Use this property to get or set the recognition module assigned to the user zone.
	PointCount	This property returns the number of corner points describing the border-walk of the zone.
	RectCount	This property returns the number of rectangles covering the whole area of this (possibly complex) user zone.
	Selected	This property sets and returns whether a specific zone is selected or not.
	Type	This property stores the type of the related user zone.
	UniqueID	This property returns the unique identifier of a specific zone.
	UserDictSection	Use this property to specify a section name in the currently used user dictionary for this user zone.
	ZoneFillingMethod	This property specifies the filling method assigned to the user zone.

Top

Methods

	Name	Description
	AddRect	This method adds a new rectangle to the current user zone area.
	Dispose	Releases all resources used by the UserZone
	Equals	(Overrides Object.Equals(Object).)
	GetDocument	Returns the parent Document object.
	GetEngine	Returns the Engine object.
	GetHashCode	(Overrides Object.GetHashCode().)
	GetTableCells	This property returns the collection of TableCell objects representing the cells of the related table.
	Point	This property returns the requested corner point of the zone boundary polyline.
	Rect	This property returns the requested rectangle from the area of this user zone.
	Scale	Calling this method shrinks or expands the related user zone based on the Percent parameter.
	Shift	Calling this method shifts the user zone according to the vector specified by the Shift parameter.
	SubRect	Calling this method subtracts a rectangle from the current user zone area.

Top

Remarks

The UserZone object provides access to the coordinates of a user zone, its content type, etc. All coordinates of this object refer to the original image.

Overlapping user zones are not supported.

Reference

Kofax.OmniPageCSDK.IproPlus Namespace