AddNew Method of the CheckmarkGroup Object

AddNew method of the CheckmarkGroup Object in the ABBYY FineReader Engine API — Creates a checkmark block and inserts it into the specified position in the group.

This method creates a checkmark block and inserts it into the specified position in the group.

Syntax

C++

HRESULT AddNew(
  int               Position,
  IRegion*          BlockRegion,
  ICheckmarkBlock** Result
);

C#

ICheckmarkBlock AddNew(
  int    Position,
  Region BlockRegion
);

Visual Basic .NET

Function AddNew( _
  Position    As Integer, _
  BlockRegion As Region _
) As ICheckmarkBlock

Parameters

Position

[in] This parameter specifies the index of the newly inserted block in the checkmark group. The value of the parameter must be in range from 0 to the value of the ICheckmarkGroup::Count property. If the block with this index already exists in the group, the elements of the collection are shifted to the right. The element may also be inserted at the end of collection, in which case the value of this parameter must be equal to the value of the ICheckmarkGroup::Count property.

BlockRegion

[in] This variable refers to the Region object that specifies the region of the newly created checkmark block. This parameter may be 0, in which case the region of the new block will be set to the region of the checkmark group.

Result

[out, retval] A pointer to ICheckmarkBlock* pointer variable that receives the interface pointer of the new checkmark block.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also

CheckmarkBlock

CheckmarkGroup