AddNewFixed Method of the DocumentDefinitions Object

This method creates a new Document Definition for structured documents (also known as fixed forms) and adds it at the end of the collection. It also searches for the blocks of specified types on the images of the sample set and adds these blocks to the Document Definition. Typical use of this mechanism would be to detect separators and anchors on the form.

After the Document Definition is added, manually mark up the blocks with data, their types and extraction parameters using the DocumentDefinition object properties and methods.


Visual Basic .NET

Function AddNewFixed(
  Name As String, _
  Images As StringsCollection, _
  AutodetectBlockTypes As BlockTypesCollection, _
) As DocumentDefinition


HRESULT AddNewFixed(
  BSTR                  Name,
  IStringsCollection    Images,
  IBlockTypesCollection AutodetectBlockTypes,
  IDocumentDefinition** Result


[in] This variable specifies the name of the Document Definition. This parameter may be 0 or an empty string. In this case the name is generated automatically.
[in] The file paths for a sample set of form images, put into a StringsCollection object.
[in] The types of blocks that should be detected on the sample images, as a BlockTypesCollection object. This parameter is optional and may be null, in which case only the anchors will be detected.
It is best to use some of the BT_Separator, BT_Anchor, BT_StaticText, BT_StaticBarcode, BT_Checkmark block types for this parameter. These block types usually correspond to objects and text that are always in the same place on each filled-in form, which will help to determine the form structure.
Note: The anchors will always be detected, regardless of this parameter value.
[out, retval] A pointer to the IDocumentDefinition* variable that receives the interface pointer for the added Document Definition.

Return values

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

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.