IBatch - ABBYY Documentation

Represents the batch.

Some methods and properties of this object are not available on the Web Verification Station for checking rules locally. The methods and properties that are not supported are marked with an asterisk (*).

Methods

The following methods require permissions for changing the batch structure. They can be called only from the batch processing script.

Method	Description
`CleanRecognitionResults( document : IDocument )` *	Deletes recognition results for the document.
`CreateDocumentFromPage( targetPosition : int, page : IPage ) : IDocument` *	Takes a page from the document and creates a new document from that page. In the `targetPosition` parameter, specify an index for the new document in the batch. The index must be a number between 0 and N, where N is the total number of documents in the batch. For details, see Create a document from a page.
`CreatePageFromImage( page : IPictureObject, [optional] target : IDocument, [optional] position : int, [optional] sourceInfo : string ) : IPage` *	Creates a page from an IPictureObject object and returns the created page. For details, see Create a page from an image.
`DeleteDocument( document : IDocument )` *	Deletes the document.
`DeletePage( page : IPage )` *	Deletes the page.
`MoveDocument( source : IDocument, targetPosition : int )` *	Moves the document to the specified position in the batch.
`MovePage( source : IDocument, target : IDocument, sourcePageIndex : int, targetPageIndex : int )` *	Moves the page with the `sourcePageIndex` index from the source document to the `targetPageIndex` position in the target document.

Create a document from a page

The CreateDocumentFromPage method takes a page from the document and creates a new document from that page. Specify the index for the new document in the targetPosition parameter. The index must be a number between 0 and N, where N is the total number of documents in the batch. When the method is called:

The documents with indexes from 0 to targetPosition - 1 remain in their original positions.
The documents with indexes from targetPosition to N move one position forward.
The new document is placed in the vacated targetPosition.

If the document becomes empty after the page is removed, it is deleted. The following example processes the first document:

IDocument document = Documents[0];
for( int i = document.Pages.Count - 1; i >= 0; --i ) 
{
    Batch.CreateDocumentFromPage( document.Index + 1, document.Pages[i] );
}

Create a page from an image

The CreatePageFromImage method creates a page from an IPictureObject object and returns the created page:

If a target document is specified, the page is added to this document. To create a one-page document, specify null as the target document.
If a position is specified, the page is added to the specified position of the document (when a target document is specified). Otherwise, a one-page document is added to the specified position of the batch (when null is specified as the target document). The initial position corresponds to 0, and the end of the document or batch corresponds to -1.
If the sourceInfo parameter is specified, it is written into the information about the page source. Otherwise, information about the page source is received from IPictureObject.

Properties

Name	Type	Access	Description
AsBatchItem *	IBatchItem	Read-only	Converts the batch into an IBatchItem object.
Attachments	IUserAttachments	Read-only	User attachments.
BatchTypeName	string	Read-only	The name of the batch type.
Comment	string	Read/write	The comment.
CreatedBy	IPrincipal	Read-only	The author of the newly created batch. For the Standalone version of ABBYY FlexiCapture, returns `null`.
CreationDate	DateTime	Read-only	The time when the batch was created.
Documents	IDocuments	Read-only	Documents the batch consists of.
Id	int	Read-only	The batch identifier (unique within the project).
Name	string	Read/write	The name of the batch.
Priority	TProcessingPriority	Read/write	The priority of the batch.
Project	IProject	Read-only	The project containing the batch.
Properties	IProperties	Read-only	Named parameters of the batch.
SLAExpirationDate	DateTime	Read/write	Processing deadline of the batch.
SlaStartDate	DateTime	Read-only	The time when processing of the batch started.
SlaWarningPeriod *	Int	Read/write	The starting time of the period during which a warning about the task’s approaching deadline is displayed. Specified in minutes remaining until the deadline.
StageInfo	IStageInfo	Read-only	Returns the IStageInfo object with information about the document’s processing stage. The `TaskId` and `PrincipalId` fields are not used.

​Methods

​Create a document from a page

​Create a page from an image

​Properties

Methods

Create a document from a page

Create a page from an image

Properties