Grooper.Core.CaptureZone

Capture Zones associate regions on a page with Data Elements in a Data Model, and are used to facilitate zonal data capture. Capture Zones are created as children of the Data Element Profiles stored on Content Types, using the Data Element Profile Manager control in Grooper Design Studio.


Inherits from: Grooper.EmbeddedObject

Constructors

Signature Description
New (Owner As ConnectedObject) Initializes a new instance of the CaptureZone class.
Parameters
Owner
          Type: ConnectedObject
          The parent of this CaptureZone.

Fields

Field Name Field Type Description
Database As Grooper.GrooperDb Grooper.GrooperDb
Id As System.Guid System.Guid

Properties

Property Name Property Type Description
Bounds Grooper.RectangleExF The location of the zone.
ContentType Grooper.Core.ContentType Returns the ContentType on which this zone is defined.
DisplayName System.String The display name of this object.
Field Grooper.Core.DataField Returns the Data Field object associated with this zone.
FieldProfile Grooper.Core.FieldProfile Returns the Field Profile on which this zone is defined.
HasReferenceProperties System.Boolean Returns true if the object has properties which reference Grooper Node objects.
IpProfile Grooper.IP.IpProfile The IP Profile to run prior to zonal extraction. This IP Profile performs temporary image cleanup prior to extraction. It does not permanently alter the image.
IsEmpty System.Boolean Returns true if all properties with a ViewableAttribute are set to their default value.
IsWriteable System.Boolean Returns true if the object is writable, or false if it is not.
Owner Grooper.ConnectedObject Returns the node that owns the connected object, if any.
OwnerNode Grooper.GrooperNode Returns the node that owns the connected object, if any.
PageNo System.Int32 The page number associated with this zone. A negative value indicates on offset starting at the end of the document. For example, -1 indicates the last page of the document -2 indicates the 2nd to last page of the document, and etc.
Root Grooper.GrooperRoot Returns the root node

Methods

Method Name Description
Clone() As CaptureZone Returns a clone of this object.
GetProperties() As PropertyDescriptorCollection
GetReferences() As List(Of GrooperNode) Returns a list of GrooperNode objects referenced in the properties of this object.
GetRuntimePageNo(NumPages As Int32) As Int32 Generates the runtime page number for a document with N pages.
Parameters
NumPages
          Type: Int32
          The number of pages in the document.
IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently enabled.
Parameters
PropertyName
          Type: String
          The name of the property to determine the enabled state for.
IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently visible.
Parameters
PropertyName
          Type: String
          The name of the property to determine the visible state for.
IsType(Type As Type) As Boolean Returns true if the object is of the type specified, or if it derives from the type specfied.
Parameters
Type
          Type: Type
          The type to check.
Serialize() As String Serializes the object.
SetDatabase(Database As GrooperDb) Sets the database connection of the object.
Parameters
Database
          Type: GrooperDb
          
SetOwner(Owner As ConnectedObject, SkipInitialization As Boolean) Sets the owner of the connected object with another object that implements the IConnected interface.
Parameters
Owner
          Type: ConnectedObject
          
 
SkipInitialization
          Type: Boolean
          
ToString() As String Returns a string value representation of the connected object.
ValidateProperties() As ValidationErrorList Validates the properties of the object, returning a list of validation errors.