ApplyDocumentDefinitions Method of the Batch Object

This method matches specified Document Definitions sections to documents of the batch. Document Definitions matching is a process of selecting document definition that can be applied to a particular page and matching document definition fields against an image. The process must be performed before recognition.

Use this method to match the Document Definitions to batch documents explicitly. With the help of this method you can select the mode of Document Definitions matching. Also you can use the Recognize method of the Batch object with correct recognition mode, in this case Document Definitions will be matched automatically before recognition.


Visual Basic .NET

Sub ApplyDocumentDefinitions( _
  DocIds As IntsCollection, _
  Incremental As Boolean, _
  Sections As SectionDefinitionsCollection _


HRESULT ApplyDocumentDefinitions(
  IIntsCollection*               DocIds,
  VARIANT_BOOL                   Incremental,
  ISectionDefinitionsCollection* Sections


[in] This parameter refers to the IntsCollection object that contains a set of indices of the documents to match Document Definitions to. This parameter may be 0, in which case Document Definitions are matched to all the documents of the batch.
[in] This parameter specifies the mode of Document Definitions matching. It can be set to TRUE if you want to match Document Definitions to the documents which do not have applied Document Definitions and the documents with changed Document Definitions. When it is set to FALSE, ABBYY FlexiCapture SDK will match document definitions to all the documents of the batch.
[in] This parameter refers to the SectionDefinitionsCollection object that specifies the sections of Document Definitions to match. This parameter may be 0, in which case ABBYY FlexiCapture SDK tries to match all Document Definitions of the project.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FlexiCapture SDK functions.


During this method call documents in the batch can be reorganized, e.g. documents can be merged or split depending on the Document Definitions applied to them, also some document identifiers can be changed.


C++ (COM) code

See also



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.