Batches Object (IBatches Interface)

This object is a collection of working batches that are part of the project you are working with and intended for processing documents. Besides standard collection methods and properties, it contains the FindById and FindByName methods that allows you to find the batch by its identifier and name. To access the batches of the certain project, use the Batches property of the corresponding Project object.

The Batches object is a so-called "connectable object". The methods of the Batches object report information about the collection modification through special outgoing interfaces. These interfaces are ICollectionEvents (for C++) and the dispinterface DICollectionEvents (for Visual Basic). It should be noted that Visual Basic users should not care for details of implementing event interfaces, as this development platform provides easy means for handling them.

Properties

Name Type Description
Count Integer, read-only Stores the number of elements in the collection.
Element Batch, read-only Provides access to a single element of the collection.

Methods

Name Description
AddNew Adds a batch with the specified name at the end of the collection of batches.
AddNewEx Adds a batch of the specified batch type at the end of the collection of batches.
FindById Provides access to a batch in the collection by the batch identifier.
FindByName Provides access to a batch in the collection by the batch name.
Item Provides access to a single element of the collection by its index in this collection.
DeleteById Removes an element with the specified identifier from the collection. You cannot delete the batch, if it is open (the IBatch::IsOpen property is TRUE).
DeleteAll Removes all the elements from the collection. You cannot delete the batch, if it is open (the IBatch::IsOpen property is TRUE).

Related objects

Samples

C++ (COM) code

This object is used in the following code samples: Hello.

See also

Project

Batch

Working with Collections

ICollectionEvents

Working with Connectable Objects

Working with Properties

15.08.2023 13:19:30

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.