NextGroup Method of the Paragraph Object

NextGroup method of the Paragraph Object in the ABBYY FineReader Engine API — Returns the index of the next character in the paragraph whose selected style parameters differ from the starting character (per a styleFlagMask).

This method returns the index of the next character in the paragraph for which the selected parameters differ from the character with which the search begins.

For example, if you set the value of the styleFlagMask parameter to SF_Bold (which means that the ICharParams::IsBold property should be taken into account) and the character with the position index is not bold, the method will return the index of the next bold character, and vice versa if the character with the position index is bold, the method will return the index of the next non-bold character.

Syntax

C++

HRESULT NextGroup(
  int  Position,
  int  CharFlagMask,
  int  StyleFlagMask,
  int* Result
);

C#

int NextGroup(
  int Position,
  int CharFlagMask,
  int StyleFlagMask
);

Visual Basic .NET

Function NextGroup( _
  Position As Integer, _
  CharFlagMask As Integer, _
  StyleFlagMask As Integer _
) As Integer

Parameters

Position

[in] This variable contains the index of the character which defines parameters of the search for the next character.

CharFlagMask

[in] This variable contains any OR combination of the CFL_ prefixed flags. It defines what character parameters are taken into account when searching for the next character.

StyleFlagMask

[in] This variable contains any OR combination of the StyleParamsEnum constants. It defines what style parameters are taken into account when searching for the next character.

Result

[out, retval] A pointer to an int variable that receives the position of the next character which has the selected parameters different from the parameters of the character with the position index. If the next character is not found, the length of the paragraph is returned.

Return values

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

Remarks

This method can be used to find all bold or italic words in the paragraph, all uncertainly recognized characters, etc.

See also

Paragraph

CFL_ prefixed flags