Click or drag to resize

UserZones Class
The UserZones collection is a sorted set of UserZone objects, where each element represents a user zone on the related page.
Inheritance Hierarchy
SystemObject
  OmniPageCSDK.IproPlusIproPlusClass
    OmniPageCSDK.IproPlusUserZones

Namespace:  OmniPageCSDK.IproPlus
Assembly:  OmniPageCSDK.IproPlus (in OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
Copy
public class UserZones : IproPlusClass, IDisposable

The UserZones type exposes the following members.

Properties
  NameDescription
Public propertyCount
This property returns the number of user zones stored in the collection.
Top
Methods
  NameDescription
Public methodAdd
This method creates a new user zone and adds it to the UserZones collection.
Public methodDeselectAll
Use this method to deselect all zones.
Public methodDispose
Releases all resources used by the UserZones
Public methodGetDocument
Returns the parent Document object.
Public methodGetEngine
Returns the Engine object.
Public methodGetEnumerator
Public methodGetItem
This property returns the requested UserZone object from the collection.
Public methodItemByUniqueID
This property allows you to identify a user zone based on its ID.
Public methodRemove
This method removes the requested user zone from the collection.
Public methodRemoveAll
This method removes all UserZone objects from the collection and invalidates all existing references to the deleted objects. Calling this method sets the Modified property of the Document object to True.
Public methodRestoreUserZones
This method restores the cached user zone set if it exists.
Public methodSaveTemplate
This method saves the current user zone-list to a zone-file or a zone template.
Public methodScaleZones
This method shrinks or enlarges the size of all user zones in the collection based on the Percent parameter.
Public methodSelectAll
Use this method to select all zones.
Public methodShiftZones
This method shifts all user zones in this collection using the vector specified by the Shift parameter.
Top
Remarks

Through its properties, the UserZones collection enables you to access and manipulate the user zone set which provides input for recognition.

After zone location or recognition, the OCRZones collection is created and the UserZones collection is synchronized accordingly. In processing methods that alter the user zone set, the collection is automatically stored for later reference to provide a way to recall the original UserZones set using the RestoreUserZones method.

See Also