BatchItem Object (IBatchItem Interface)

This object corresponds to a batch item. A batch item can represent a page or a document.

The BatchItem object should be used in addition to the usual functionality in scenarios when an item of a batch can be a document set as well as a single document. Marking a document as a BatchItem allows you to include more child documents into it.

Properties

Name Type Description
AsDocument Document, read-only Returns a Document object, if the batch item is a document. Otherwise this property is NULL.
AsPage Page, read-only Returns a Page object, if the batch item is a page. Otherwise this property is NULL.
ChildItems BatchItems, read-only Returns a collection of child items of the batch item.
Id Integer, read-only Stores an identifier of the batch item.
Type BatchItemTypeEnum, read-only Stores the type of the batch item.

Related objects

See also

BatchItems

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.