Overview
PSIcapture's scripting environment exposes subsets of the major classes whose objects comprise a batch. These objects are passed into various script methods, allowing the script to access batch values for decision making. The objects themselves are not editable; however, some of the properties within the objects can be manipulated either directly or through exposed methods in the classes.
The following page describes the basic hierarchy of a batch as it applies to scripting, and provides descriptions of the interface classes used to represent these objects.
Examples:
- A batch object is described using the IBatch class.
- Within the batch object, there is a collection of folders which is represented by the IFolders class.
- Each folder inside the folders collection is represented by the IFolder class.
- Each folder contains a set of documents, which is represented by the IDocuments class.
Basic Batch Hierarchy
The following diagram is a simplified view of the basic batch hierarchy. Each box is represented by an interface class. These classes are discussed in detail in the next section.
Drag and Drop
Users have the ability to drag and drop available scripts from the left panel into the scripting panel. NOTE: There are limitations to what you can drag as outlined below.
Cannot drag to:
- Open and ending brackets { }
- The Catch section
- The class definition
- The function definition
Class Descriptions
IAlert
Alerts are used to notify the user of a specific condition.
IAlert Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| AlertType | AlertTypes | No* | Gets the type of alert applied to the context object. |
| Message | string | No* | Gets the message assigned to the alert. |
*Alerts can be added or removed through the methods in the IAlerts class (see below).
IAlerts
This is a collection of IAlert objects
IAlerts Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| IAlerts[AlertType] | IAlert | No |
Returns the specified IAlert object from the collection based on the supplied alert type. ex. document.Alerts[AlertTypes.LookupFailed] |
IAlerts Methods
Creates a new alert and adds it to the collection. If an alert with the specified alert type already exists it will be replaced.
Parameters
| Name | Type | Description |
|---|---|---|
| alertType | AlertTypes | The alert type |
| message | string | The alert's message |
Returns
The IAlert object that was created and added to the IAlerts collection.
Returns True if the alerts list contains the specified alert type.
Parameters
| Name | Type | Description |
|---|---|---|
| alertType | AlertTypes | The alert type |
Returns
True or False
Returns True if the alerts list contains the specified IAlert object.
Parameters
| Name | Type | Description |
|---|---|---|
| alert | IAlert | The alert object to search for |
Returns
True or False
Generates a string value from all alerts in the collection, suitable for display in a user interface, or logging to a file, etc.
Returns
The combined alert display string.
Removes the specified alert from the collection.
Parameters
| Name | Type | Description |
|---|---|---|
| alert | IAlert | The alert to remove |
Returns
Nothing
Removes the alert of the specified type from the collection.
Parameters
| Name | Type | Description |
|---|---|---|
| alertType | AlertTypes | The alert type to remove |
Returns
Nothing
Removes the alert at the specified position in the IAlerts collection. The list is zero-based.
Parameters
| Name | Type | Description |
|---|---|---|
| index | integer | The alert of the alert to remove |
Returns
Nothing
Removes all alerts for the collection.
Returns
Nothing
IBarcode
An IBarcode object contains the metadata describing a single recognized barcode.
IBarcode Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Area | RectangleF | No | Gets the area of the barcode. This is an axis aligned bounded box that contains the entire area of the barcode data on the image. |
| ConfidenceLevel | Integer | No | Gets the confidence level reported by the barcode recognition engine when reading this barcode. Not all barcode types may provide a confidence level. |
| Data | String | No | Gets the raw barcode data decoded at the time of read. |
| Name | String | No | Gets the display name of the barcode type recognized for this barcode. |
| Number | Integer | No | Gets the barcode number assigned to this barcode. Barcodes are read and numbered left to right, top to bottom. |
| NumberCheckSumCharacters | Integer | No | Gets the number of check sum characters that were read for this barcode. Not all barcode types support check sum characters. |
| Orientation | Integer | No | Gets the orientation of the barcode, as reported by the recognition engine. |
| Type | BarcodeTypes | No | Gets the barcode type (see Enumerations). |
| ValidCheckSum | Boolean | No | Gets a value indicating whether the check sum value read is valid. Not all barcode types support check sums. |
| Value | String | No | Gets the final barcode value. This value is assigned after all data cleanup, splitting, etc., has been applied. |
IBatch
The IBatch object contains general information concerning the overall batch.
IBatch Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Alerts | IAlerts | No* | A list of all alerts - see the The Interface Objects#alert for more details |
| AutoRecognitionBatch | Boolean | No | Was the batch created by PSIcapture auto recognition |
| BatchName | String | No | The name assigned to the batch |
| BatchNote | String | Yes | Comments entered for the batch |
| Bookmark | IBatchBookMark | No** | The batch's bookmarked folder, document and/or page |
| Completed | Boolean | No | Returns true if the batch has been completed |
| CompletionDate | Date/Time | No | The date and time the batch completed, if applicable |
| CreateDate | Date/Time | No | The date and time the batch was created |
| CreatedBy | String | No | The user ID of the user who created the batch |
| CurrentWorkflowStep | Integer | No | The current workflow step number |
| DeadlineDate | Date/Time | No | The date and time when the batch's next deadline will expire |
| DocumentCount | Integer | No | The number of documents in the batch |
| DocumentRecordCount | Integer | No | The number of data records across all documents in the batch |
| DocumentType | IDocumentType | No | The Capture Profile that was used to create the batch. Use it to access all of the batch's settings. |
| ExceptionsBatch | Boolean | No | Is the batch an exceptions batch? |
| ExceptionsBatchID | Integer | No | If the batch contained exceptions, this is the unique ID number for the exceptions batch |
| ExpectedCounts | IExpectedCounts | No | The expected folder, document, page, etc., counts as defined in the Capture Profile |
| ExpectedCountValidation | ExpectedCountValidationTypes | No | The method used to validate expected counts (NoValidation, ValidationTotals, ValidateByLevel) |
| Flag | FlagTypes | Yes | Flags the batch using one of the available flag types |
| FolderCount | Integer | No | The number of folders in a batch |
| Folders | IFolders | No | The collection of folders in the batch. This object provides access to the documents (IDocuments collection) in each folder. See the The Interface Objects#folderThe Interface Objects#folder for details. |
| HeldBatch | Boolean | No | Is the batch held? |
| HighPriorityBatch | Boolean | Yes*** | Is this a high-priority batch? |
| ID | Integer | No | The unique batch ID assigned by PSIcapture |
| PageCount | Integer | No | The total number of pages in the batch |
| Path | String | No | The batch storage path |
| Record | IDataRecord | No | The data record containing the batch-level index values |
| SeparatorSheet | IPage | No | The separator page, if applicable. See the The Interface Objects#page for details. |
| SuspendedBatch | Boolean | No | Has the batch been suspended? |
| WorkflowStepCount | Integer | No | The total number of workflow steps for the batch |
*Alerts can be added or removed through the methods in the The Interface Objects#alert.
**Use the SetBookmark method explained in the below section to alter bookmarks.
*** In order to change the value of the HighPriorityBatch property, you must return true from the EnableUnrestrictedCode script method.
IBatch Methods
The GetFlaggedBatchItems method returns folders, documents, and pages that have been flagged with the designated flag type.
Parameters
| Name | Type | Description |
|---|---|---|
| flagType | FlagTypes | The flag type to search for |
| includeFlaggedChildrenOfFlaggedParent | Boolean | If true, a flagged "parent" object will also return all of the "child" objects in that parent. See the notes section below for more detail. |
| flaggedFolders | ref List of IFolder | The list of flagged folders |
| flaggedDocuments | ref List of IDocument | The list of flagged documents |
| flaggedPages | ref List of IPage | The list of flagged pages |
Returns
Nothing; all data is returned via the reference parameters.
Notes
Use the includeFlaggedChildrenOfFlaggedParent parameter to control what is returned:
| Item | True | False |
|---|---|---|
| return flagged folder | yes | yes |
| return flagged document in flagged folder | yes | no |
| return flagged document in unflagged folder | yes | yes |
| return flagged pages in a flagged document | yes | no |
| return flagged pages in an unflagged document | yes | yes |
GetFlaggedBatchPages returns the list of all pages in a batch that are flagged with the designated flag type. If the includePagesOfFlaggedParent parameter is set to true, pages from flagged documents and folders are also returned regardless of each page's flag setting.
Parameters
| Name | Type | Description |
|---|---|---|
| flagType | FlagTypes | The type of flag to look for (Review, Reject, Skip, etc.) |
| includePagesOfFlaggedParent | Boolean | If true, all the pages of a flagged "parent" object will be returned as well. See the notes section below for more details. |
| flaggedPages | ref List of IPage | The list of flagged pages |
Returns
Nothing; all data is returned through the reference parameter
Bookmarks a particular folder, document, and/or page.
Parameters
| Name | Type | Description |
|---|---|---|
| bookmarkFolder | IFolder | The folder to bookmark, or null |
| bookmarkDocument | IDocument | The document to bookmark, or null |
| bookmarkPage | IPage | The page to bookmark, or null |
Returns
Nothing
IBatchBookmark
The folder, document, and/or page bookmarked in the batch. These values are set using the SetBookmark method in IBatch.
IBookmark Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| BookmarkFolder | IFolder | No | The folder to bookmark |
| BookmarkDocument | IDocument | No | The document to bookmark |
| BookmarkPage | IPage | No | The page to bookmark |
IBatesStamp
The name and value information for a single Bates stamp.
IBatesStamp Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Name | String | No | The Bates stamp name |
| Value | String | No | The value of the Bates stamp |
ICharacterZone
ICharacterZone contains the properties of a single character (OCR) zone.
ICharacterZone Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Area | RectangleF | No | The zone bounds |
| Confidence | Double | No | The percentage of confidence in the OCR result (0-100) |
| IsMultiRecLineZone | Boolean | No | True if the zone represents a multi-record line item zone |
| Name | String | No | The zone name |
| Number | Integer | No | The zone number |
| Value | String | No | The zone's value |
IDataField
Represents a single index data field.
IDataFieldProperties
| Name | Type | Editable | Description |
|---|---|---|---|
| ID | Long | No | The index field's unique identifier |
| Name | String | No | The index field name |
| DataType | DataFieldDataTypes | No | The data type of the index field |
| FieldType | DataFieldTypes | No | Indicates the index field type (batch, folder, document, or system) |
| RecordType | String | No | The record type associated with the index field |
| RecordTypes | List of String | No | |
| DefaultValue | String | No | The default value for the index field |
| InputMask | String | No | The input mask for the index field to force correct formatting |
| MinimumLength | Integer | No | The minimum allowed length |
| MaximumLength | Integer | No | The maximum allowed length |
| Required | Boolean | No | Index value required flag |
| Skip | Boolean | No | Index field Skip flag |
| Sticky | Boolean | No | Index field Sticky flag |
| ReKey | Boolean | No | Index field ReKey flag |
| Hide | Boolean | No | Index field Hide flag |
| ReadOnly | Boolean | No | Index field Read-only flag |
| Synchronized | Boolean | No | Index field synchronization flag (used for multi-record processing) |
| UseSelectionList | Boolean | No | Indicates if the index field should be populated from a user-supplied list |
| LimitEntryToSelectionList | Boolean | No | Flag to determine if the user supplied list of values is editable |
| AppendUserEntriesToSelectionList | Boolean | No | Flag to signify if new entries entered by users on the index form should be appended to the list |
| ListSelectionItems | List of IListSelectionItem | No | User-supplied list of values |
| AutoIncrement | Boolean | No | Index field will auto-increment |
| AutoIncrementCounterName | String | No | The counter used for auto-incrementing an index field |
| IsAutoIncrementSharedCounter | Boolean | No | Flag for whether or not AutoIncrementCounterName is a shared counter |
| MapFieldToBarcode | Boolean | No | Determines if the index field is to be populated from a barcode |
| BarcodeType | BarcodeTypes | No | When the index field is set to populate from a barcode, this defines the type of barcode to use |
| BarcodeNumber | Integer | No | Specifies which barcode to use if multiple ones of the same type are found |
| BarcodePageNumber | Integer | No | Specifies which page number to use when locating the barcode |
| ZoneName | String | No | The name of the zone associated with the index field |
| ZoneAction | DataFieldZoneActions | No | The type of zone associated with the index field |
IDataFields
Represents a collection of index fields (IDataField objects as described in the section above).
IDataFields Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| IDataFields[IndexName] | IDataField | No | Returns the specified IDataField object from the collection based on the supplied index field name |
| FieldNames | Array of Strings | No | The index field names of each IDataField object in the collection |
IDataFields Methods
Returns true if the collection contains an IDataField identified by the given name.
Parameters
| Name | Type | Description |
|---|---|---|
| fieldName | String | The field name to search for |
Returns
Boolean
IDataFieldValue
Represents an individual index field value. A collection of IDataFieldValue objects makes up one IDataRecord.
IDataFieldValue Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Name | String | No | The index field name associated with this value |
| DataType | DataFieldDataTypes | No | The data type |
| Alerts | IAlerts | No | The list of alerts associated with this index value |
| Value | Object | Yes | The index value |
| StringValue | String | No | The textual representation of the index value |
| ValueSetByScript | Boolean | No | True if you change the Value property from within the scripting environment |
| ReindexValue | Object | Yes | The value re-keyed in the second indexing step when the Indexing re-key option is enabled |
| ReindexValueSetByScript | Boolean | No | True if you change the ReindexValue property from within the scripting environment |
| TypedValue | Object | No | This is the Value of the index field that has been cast to the index field's defined value |
| Validated | Boolean | No | Flag that signals if the index value has already been passed through validation |
| DataSourcePageNumber | Integer | No | The source page number that produced the OCR value stored in the index field |
| DataSourceBounds | RectangleF | No | The bounds of the OCR zone that produced the OCR value stored in the index field |
| OCRConfidenceLevel | Float | No | The OCR confidence level of the OCR value used to populate the index field. Expressed as a decimal number from 0 to 1. |
| BypassOcrConfidenceLevelCheck | Boolean | Yes | True if you want to bypass further OCR confidence level checks in validation |
IDataFieldValue Methods
Sets a validation alert message for index data field.
Parameters
| Name | Type | Description |
|---|---|---|
| message | string | The validation alert message |
Returns
Nothing
IDevicePage (v5.3.1+)
Represents information about a single page image.
IDevicePage Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Front | Boolean | No | Whether or not the image is the front side of a page. |
| SourceFile | String | No | The path and file name of the imported file that contained this page. |
| ImageHeight | Integer | No | The image height |
| ImageWidth | Integer | No | The image width |
| Imprint | IImprint | No | The imprinted text on this page (if any) |
| OrientationIsIndeterminate | Boolean | No | True if the PSIcapture default auto-orientation engine could not accurately determine the orientation of the image. |
| Barcodes | List of IBarcode | No | The list of barcodes on the page |
| PatchCodes | List of IPatchCode | No | The list of patch codes on the page |
| FirstPageOfImportedFile | Boolean | No | Whether or not this is the first page of the imported file |
| BlankPage | Boolean | No | Whether or not this is a blank page |
| SourceFilePageNumber | Integer | No | The page number for this page within the source file |
| SourceFileCreateDateTime | Date/Time | No | The source file creation timestamp as reported by Windows |
| SourceFileModifiedDateTime | Date/Time | No | The source file modification timestamp as reported by Windows |
| BarcodeRecognitionCompleted | Boolean | No | Whether or not barcode recognition has completed for this page |
| PatchCodeRecognitionCompleted | Boolean | No | Whether or not patch code recognition has completed for this page |
| BlankPageRecognitionCompleted | Boolean | No | Whether or not blank page detection has completed for this page |
| UsedOCR | Boolean | No | Indicates if OCR operations were performed for this page |
| UsedICR | Boolean | No | Indicates if ICR operations were performed for this page |
| UsedADE | Boolean | No | Indicates if ADE operations were performed for this page |
IDataRecord
Contains a list of IDataFieldValues that make up a single batch, folder, or document record.
IDataRecord Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| RecordIndex | Integer | No | The record index |
| FieldNames | Array of String | No | The names of each index field in the record |
| IsAutoCreatedRecord | Boolean | No | Flag to indicate the record was created automatically |
| RecordType | String | Yes | The record type assigned to the record |
| AutoCreatedRecordTag | String | No | |
| RelatedRecords | Array of IDataRecord | No | The list of records related to this record |
| IDataRecord[IndexName] | IDataFieldValue | No | Returns the specified IDataFIeldValue object from the collection based on the supplied index field name |
IDataRecord Methods
Returns true if the collection contains an IDataFieldValue identified by the given name.
Parameters
| Name | Type | Description |
|---|---|---|
| fieldName | string | The index field name |
Returns
Boolean
IDocument
Represents a single document in the batch.
IDocument Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| ID | Integer | No | Document ID |
| Name | String | No | Document name |
| DocumentPath | String | No | External document path and file |
| DocumentNumber | Integer | No | Document sequence in the folder |
| DocumentNumberInBatch | Integer | No | Document sequence in batch |
| DocumentNote | String | Yes | Notations about the document |
| Indexed | Boolean | Yes | Flag signaling that indexing has been performed on this document |
| IndexedBy | String | Yes | User performing the index operation |
| ReIndexed | Boolean | Yes | Flag signaling that re-indexing has been performed on this document |
| ReIndexedBy | String | Yes | User performing the re-index operation |
| LookupMultirecHasBeenRun | Boolean | No | A flag indicating that lookup queries have been run for all document records in a multi-record process |
| ClassificationFormID | String | No | The classification form ID (if classification produced this document) |
| ClassificationFormPageCount | Integer | No | The number of pages in the classification document |
| ClassificationDocumentID | String | No | The combination of the classification form ID and the document ID |
| Records | IDataRecords | No* | The list of records for the document |
| Pages | IPages | No | The collection of pages in the document |
| PageCount | Integer | No | The document page count |
| PagePaths | Array of Strings | No | The path and file name for each page image in batch storage |
| SeparatorSheet | IPage | No | The page that caused document separation |
| SeparatorValue | String | No | The detected value that cause document separation (if any) |
| DocumentFiles | IDocumentFiles | No | The collection of external file information for all pages of the document |
| Alerts | IAlerts | No** | The list of document alerts |
| Flag | FlagTypes | Yes | The specified flag for the document (if any) |
| Batch | IBatch | No | The document's batch |
| Folder | IFolder | No | The document's folder |
| DocumentBarcodes | List of IBarcode | No | The list of barcode objects for the document |
*Records can be added to the document through the AddNewRecord method explained in the below section.
**Alerts can added or removed through the methods in the IAlerts class or through the SetValidationAlert method explained in the below section.
IDocument Methods
This method adds a new, empty record to the document's record collection (Records).
Returns
The index of the new record in the document's record collection.
Indicates if the document has been migrated by any migration workflow step.
Returns
True or False
Indicates if the document has been migrated by a particular migration workflow step.
Parameters
| Name | Type | Description |
|---|---|---|
| workflowMigrationInstanceNumber | integer | The workflow step number for the desired migration step |
| migrationNumber | integer | This row number for the actual migration to check within the migration workflow step |
Returns
True or False
Indicates if the OCR workflow step has been run for the document.
Returns
True or False
Indicates if a particular OCR workflow step has been run for the document.
Parameters
| Name | Type | Description |
|---|---|---|
| workflowFullTextOCRInstanceNumber | integer | The workflow number for the desired OCR workflow step |
Returns
True or False
Adds an alert of type AlertTypes.DataValidationFailed to the list of document alerts. If a DataValidationFailed alert already exists in the list, it will be overwritten.
Parameters
| Name | Type | Description |
|---|---|---|
| message | string | The alert's message |
Returns
Nothing
IDocumentFile
An external file of information associated with a document.
IDocumentFile Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Document | IDocument | No | The parent document |
| FileSource | DocumentFileSource | No | The source of the document file (see Enumerations) |
| FileTag | String | No | The tag assigned to the file |
| FileType | String | No | The type of the original image file |
| FullPath | String | No | The full path and file name |
| ID | Integer | No | A unique ID for the object |
| IsDirectory | Boolean | No | Whether or not the IDocumentFile object represents a directory or a file |
| Path | String | No | The path for the file |
IDocumentFiles
The collection of IDocumentFile objects for a document.
IDocumentFiles Methods
Searches the collection for the specified IDocumentFile object.
Parameters
| Name | Type | Description |
|---|---|---|
| item | IDocumentFile | The IDocumentFile object to find |
Returns
True or False
Searches the collection for the IDocumentFile object identified by the given path.
Parameters
| Name | Type | Description |
|---|---|---|
| path | string | The path to locate |
Returns
True or False
Finds and returns the IDocumentFile object identified by the specified file ID.
Parameters
| Name | Type | Description |
|---|---|---|
| fileID | integer | The file ID to locate |
Returns
IDocumentFile object
Finds and returns the IDocumentFile object identified by the specified file path.
Parameters
| Name | Type | Description |
|---|---|---|
| path | string | The path to locate |
Returns
IDocumentFile object
IDocuments
This represents the collection of documents for a given folder.
IDocuments Methods
Returns the document from the collection identified by the supplied document ID number.
Parameters
| Name | Type | Description |
|---|---|---|
| documentID | integer | The document ID |
Returns
An IDocument object
Returns the document from the collection identified by the supplied document name.
Parameters
| Name | Type | Description |
|---|---|---|
| documentName | string | The document name |
Returns
An IDocument object
IDocumentType
This is a subset of the parameters for the Capture Profile used to create the batch.
IDocumentType Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| ID | Long | No | The Capture Profile's unique ID |
| Name | String | No | The Capture Profile name |
| Created | Date/Time | No | The date and time the Capture Profile was created |
| Description | String | No | Describes the Capture Profile |
| Group | String | No | The display group |
| BatchFields | IDataFields | No | The list of batch index fields |
| FolderFields | IDataFields | No | The list of folder index fields |
| IndexFields | IDataFields | No | The list of document index fields |
| DefaultExpectedCounts | IExpectedCounts | No | The expected count object collection |
| ExpectedCountValidation | ExpectedCountValidationTypes | No | The method used to validate expected counts (NoValidation, ValidationTotals, ValidateByLevel) |
| DocumentRecordTypes | Array of Strings | No | The list of record types |
IExpectedCounts
This represents the Expected Count Validation for the batch as specified in the Capture Profile.
IExpectedCounts Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| DocumentsPerFolder | Integer | No | Documents per folder setting |
| DocumentsPerFolderOperator | ExpectedCountOperators | No | See ExpectedCountOperators on the Enumerations page |
| FoldersPerBatch | Integer | No | Folders per batch setting |
| FoldersPerBatchOperator | ExpectedCountOperators | No | See ExpectedCountOperators on the Enumerations page |
| PagesPerDocument | Integer | No | Pages per document setting |
| PagesPerDocumentOperator | ExpectedCountOperators | No | See ExpectedCountOperators on the Enumerations page |
| TotalDocuments | Integer | No | Total documents per batch setting |
| TotalDocumentsOperator | ExpectedCountOperators | No | See ExpectedCountOperators on the Enumerations page |
| TotalFolders | Integer | No | Total folders per batch setting |
| TotalFoldersOperator | ExpectedCountOperators | No | See ExpectedCountOperators on the Enumerations page |
| TotalPages | Integer | No | Total pages per batch setting |
| TotalPagesOperator | ExpectedCountOperators | No | See ExpectedCountOperators on the Enumerations page |
IFolder
IFolder represents a single folder object in the batch.
IFolder Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Alerts | IAlerts | No* | The folder's alert collection |
| Batch | IBatch | No | The parent batch |
| Documents | IDocuments | No | The folder's document collection |
| Flag | FlagTypes | Yes | The folder's flag |
| FolderNote | String | Yes | A note describing the folder |
| FolderNumber | Integer | No | The sequential folder number |
| FolderPath | String | No | The path for the folder's storage in the batch |
| ID | Integer | No | The unique folder ID |
| Indexed | Boolean | No | Flag signaling that indexing has been performed on this folder |
| Name | String | No | The folder name |
| Record | IDataRecord | No | The folder's single record |
| ReIndexed | Boolean | No | Flag signaling that re-indexing has been performed on this folder |
| SeparatorSheet | IPage | No | The folder's separation page |
| SeparatorValue | String | No | The detected value that caused folder separation (if any) |
| PageCount | Integer | No | The total number of pages across all documents in the folder |
*Alerts can be added or removed through the methods in the IAlerts class or through the SetValidationAlert method explained in the section below.
IFolder Methods
Adds an alert of type AlertTypes.DataValidationFailed to the list of folder alerts. If a DataValidationFailed alert already exists in the list, it will be overwritten.
Parameters
| Name | Type | Description |
|---|---|---|
| message | string | The alert's message |
Returns
Nothing
IFolders
The IFolder object represents the collection of folders for a batch.
IFolders Methods
Searches the collection for the specified IFolder object.
Parameters
| Name | Type | Description |
|---|---|---|
| folderName | string | The name of the folder to locate |
Returns
True or False
Returns the IFolder object from the collection identified by the given ID.
Parameters
| Name | Type | Description |
|---|---|---|
| folderID | integer | The ID of the folder to return from the collection |
Returns
The requested IFolder object from the collection
Returns the IFolder object from the collection identified by the given folder name.
Parameters
| Name | Type | Description |
|---|---|---|
| folderName | string | The name of the folder to return from the collection |
Returns
The requested IFolder object from the collection
IImprint
References the imprinted text for a document page.
IImprint Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Left | Integer | No | The left offset for the text |
| Text | String | No | The imprinted text |
| Top | Integer | No | The top offset for the text |
IListSelectionItem
IListSelectionItem represents an individual item in a user-defined list for populating index fields.
IListSelectionItem Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| DataValue | String | No | The actual value for the index |
| DisplayValue | String | No | The value display in the list on the Index form |
IMarkArea
This represents the area for an individual OMR item.
IMarkArea Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| AdjustedNetWeight | Integer | No | The value used to actually make OMR selections based on marked weight |
| Area | RectangleF | No | The mark area |
| BaseWeight | Integer | No | The pixel weight of this area on the template image |
| EffectiveBaseWeight | Integer | No | The actual base weight used in all calculations. This will be 0 if the option to ignore base weights has been selected. |
| MaximumWeight | Integer | No | The calculated maximum possible weight for the given area. This is used for calculating the scaled weight. |
| NetWeight | Integer | No | The raw filled pixel count less the base weight |
| ScaledWeight | Integer | No | The weight value for the area, scaled into a percentage of maximum weight (0-100). |
| Selected | Boolean | No | A flag indicating whether or not the mark area has been filled in, or has been filled in the most compared to other boxes that may have been partially filled in. |
| Tag | String | No | A tag assigned to the mark |
| Value | String | No | The associated value for the mark |
| Weight | Integer | No | The raw pixel count for filled pixels in the area |
| WeightAdjustment | Integer | No | The difference between Weight and NetWeight, which produces AdjustedNetWeight |
IMarkZone
This represents an OMR zone which contains an array of IMarkArea objects.
IMarkZone Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| MarkAreas | List of IMarkArea | No | The individual mark area that make up the zone |
| Name | String | No | The zone name |
| Number | Integer | No | The zone number |
| Value | String | No | The zone value |
IPage
This represents a single page within a document.
IPage Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| ID | Integer | No | Unique page ID |
| Name | String | No | Page name |
| Path | String | No | The path to the image file in batch storage |
| PageNumber | Integer | No | The page number in the document |
| PageNote | String | Yes | Notes about the page |
| HorizontalResolution | Integer | No | Horizontal image resolution |
| VerticalResolution | Integer | No | Vertical image resolution |
| FrontPage | Boolean | No | Flag to signal if this is a front page |
| BlankPage | Boolean | No | Flag to signal if this is a blank page |
| DocumentSeparator | Boolean | No | Flag to signal if this is a document separation page |
| FolderSeparator | Boolean | No | Flag to signal if this is a folder separation page |
| PageColor | ImageColorTypes | No | The color setting for the page (see Enumerations) |
| SourceFile | String | No | The source file that produced the page |
| SourceFilePageNumber | Integer | No | The page number in the original source file |
| Flag | FlagTypes | Yes | Page flag |
| Alerts | IAlerts | No* | Page alerts |
| Document | IDocument | No | The page's parent document |
| AlternatePageFiles | IPageFiles | No | A collection of alternate page files |
| Barcodes | List of IBarcode | No | The page's barcode collection |
| PatchCodes | List of IPatchCode | No | The page's patch code collection |
| BatesStamps | List of IBatesStamp | No | The page's Bates stamp collection |
| Imprint | IImprint | No | The page's imprinted text |
| OCRConfidenceLevel | Float | No | The OCR confidence level (0-100) |
| Words | List of IWord | No | The word collection |
| CharacterZones | List of ICharacterZone | No | The character zone collection |
| MarkZones | List of IMarkZone | No | The mark zone collection |
| PDFBookmarks | IPDFBookmarks | No | The PDF bookmark collection |
| RedactionResults | List of IRedactionResult | No | The redaction results collection |
*Alerts can be added or removed through the methods in the IAlerts class or through the SetValidationAlert method explained in the section below.
IPage Methods
Adds an alert of type AlertTypes.DataValidationFailed to the list of folder alerts. If a DataValidationFailed alert already exists in the list, it will be overwritten.
Parameters
| Name | Type | Description |
|---|---|---|
| message | string | The alert's message |
Returns
Nothing
Returns all text from the alternate page file "Page Text".
Returns
All lines of text from the file
IPages
Represents a document's IPage collection.
IPages Methods
Obtain a matching IPage object based on the page's ID.
Parameters
| Name | Type | Description |
|---|---|---|
| pageID | integer | The IPage ID |
Returns
An IPage object or null
Obtain a matching IPage object based on the supplied page number.
Parameters
| Name | Type | Description |
|---|---|---|
| pageNumber | integer | The document page number |
Returns
An IPage object or null
IPageFile
An external file of information associated with a document's page.
IPageFIle Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| FileSource | PageFileSource | No | The origin of the page file (see Enumerations) |
| FileTag | String | No | The textual identifier for the page file |
| FileType | String | No | The type of file |
| ID | Integer | No | The unique ID for this page file |
| Page | IPage | No | The parent page |
| Path | String | No | The path for the page file |
IPageFiles
Contains a collection of IPageFile objects.
IPageFiles Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Page | IPage | No | The associated document page |
IPageFiles Methods
Determines if the specified IPageFile object exists in the collection.
Parameters
| Name | Type | Description |
|---|---|---|
| item | IPageFile | The object to locate |
Returns
True or False
Determines if the specified IPageFile object exists in the collection based on the supplied path.
Parameters
| Name | Type | Description |
|---|---|---|
| path | string | The IPageFile path information to locate |
Returns
True or False
Returns the IPageFile object from the collection identified by the supplied file source and tag.
Parameters
| Name | Type | Description |
|---|---|---|
| fileSource | PageFileSource | The source of the file page (see Enumerations) |
| tag | string | The FileTag property of the IPageFile object |
Returns
An IPageFile object from the collection or null if not found
Returns the IPageFile object from the collection identified by the supplied tag.
Parameters
| Name | Type | Description |
|---|---|---|
| tag | string | The FileTag property of the IPageFile object |
Returns
An IPageFile object from the collection or null if not found
Returns the IPageFile object from the collection identified by the supplied page file ID.
Parameters
| Name | Type | Description |
|---|---|---|
| fileID | integer | The page file ID |
Returns
An IPageFile object from the collection or null if not found
Returns the IPageFile object from the collection identified by the supplied path.
Parameters
| Name | Type | Description |
|---|---|---|
| path | string | The page file's path |
Returns
An IPageFile object from the collection or null if not found
IPatchCode
This represents an individual patch code object.
IPatchCode Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Area | RectangleF | No | The area on the page containing the patch code |
| ConfidenceLevel | Integer | No | The confidence level (0-100) |
| Number | Integer | No | The sequence of the patch code on the page |
| Type | PatchCodeTypes | No | The patch code type (see Enumerations) |
| SkewAngle | Integer | No | The angle at which the patch code is skewed |
IPDFBookmark
This represents an individual PDF bookmark object.
IPDFBookmark Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Color | Color | No | The System.Drawing.Color of the bookmark |
| FontStyle | FontStyle | No | The font style |
| Level | Integer | No | It will be an integer value >= 1 |
| Name | String | No | The bookmark name |
IPDFBookmarks
Represents a collection of IPDFBookmark objects.
IPDFBookmarks Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Page | IPage | No | The page containing the bookmarks |
IPDFBookmarks Methods
Determines if the specified IPDFBookmark objects exists in the collection
Parameters
| Name | Type | Description |
|---|---|---|
| item | IPDFBookmark | The object to locate |
Returns
True or False
Creates a new IPDFBookmark object and adds it to the end of the collection.
Parameters
| Name | Type | Description |
|---|---|---|
| name | string | IPDFBookmark name |
| level | integer | IPDFBookmark level |
| color | System.Drawing.Color | IPDFBookmark color |
| fontStyle | System.Drawing.FontStyle | IPDFBookmark font style |
Returns
The new IPDFBookmark object
Removes the specified IPDFBookmark object from the collection.
Parameters
| Name | Type | Description |
|---|---|---|
| item | IPDFBookmark | The object to remove |
Returns
Nothing
Removes all IPDFBookmark objects from the collection.
Returns
Nothing
IRedactionResult
This represents a single redaction result on a page.
IRedactionResult Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| RedactionType | RedactionTypes | No | See the RedactionTypes section on the Enumerations page. |
| Bounds | RectangleF | No | The area of the redaction |
| RedactedWord | String | No | The word that was redacted |
| MatchExpression | String | No | The regular expression used to select the word for redaction |
IRedactionResults
This represents a collection of IRedactionResult objects.
IRedactionResults Methods
Creates a new IRedactionResult object and adds it to the end of the collection.
Parameters
| Name | Type | Description |
|---|---|---|
| redactionType | RedactionTypes | The IRedactionType RedactionType |
| bounds | RectangleF | The IRedactionType Bounds |
| redactedWord | string | The IRedactionType RedactedWord |
| matchExpression | string | The IRedactionType MatchExpression |
Returns
The new IRedactionType object.
Determines if a IRedactionResult object exists in the collection based on the supplied type.
Parameters
| Name | Type | Description |
|---|---|---|
| redactionType | RedactionTypes | The redaction type to locate |
Returns
True or False
Determines if the specified IRedactionResult object exists in the collection.
Parameters
| Name | Type | Description |
|---|---|---|
| redactionResult | IRedactionResult | The IRedactionResult object to locate |
Returns
True or False
Removes the specified IRedactionResult object from the collection.
Parameters
| Name | Type | Description |
|---|---|---|
| redactionResult | IRedactionResult | The IRedactionResult object to remove |
Returns
Nothing
Removes the specified IRedactionResult object from the collection at the specified index.
Parameters
| Name | Type | Description |
|---|---|---|
| index | integer | The index of the IRedactionResult object to remove |
Returns
Nothing
Removes all IRedactionResult objects from the collection.
Returns
Nothing
IUserMetaData
This represents a set of user information for a batch.
IUserMetaData Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| UserName | String | No | The user ID |
| String | No | The user's email address | |
| FirstName | String | No | The user's first name |
| LastName | String | No | The user's last name |
IWord
This represents a single word on a page.
IWord Properties
| Name | Type | Editable | Description |
|---|---|---|---|
| Bounds | RectangleF | No | The area of the page that contains the word |
| Confidence | Double | No | The OCR confidence |
| Text | String | No | The text of the word |
Comments
Article is closed for comments.