SetCharParams Method of the Paragraph Object

SetCharParams method of the Paragraph Object in the ABBYY FineReader Engine API — Sets the CharParams for a group of characters within the paragraph.

This method sets parameters for a group of characters.

Syntax

C++

HRESULT SetCharParams(
  int          Position,
  int          Count,
  ICharParams* Params,
  int          CharFlagMask,
  int          StyleFlagMask
);

C#

void SetCharParams(
  int        Position,
  int        Count,
  ICharParams Params,
  int        CharFlagMask,
  int        StyleFlagMask
);

Visual Basic .NET

Sub SetCharParams( _
  Position As Integer, _
  Count As Integer, _
  Params As ICharParams, _
  CharFlagMask As Integer, _
  StyleFlagMask As Integer _
)

Parameters

Position

[in] Position of character in paragraph that starts the group of characters for which the parameters are set. It should be in the range from 0 to the length of paragraph.

Count

[in] A number of characters for which the parameters are set. It should be no less than 0 and meet the following requirement: position + count <= paragraph length + 1

Params

[in] This variable refers to the CharParams object that contains the new parameters for the group of characters. It must refer to a valid object.

CharFlagMask

[in] This variable may contain any OR combination of the CFL_prefixed flags. It specifies what character parameters are to be copied from the params object.

StyleFlagMask

[in] This variable may contain any OR combination of the StyleParamsEnum constants. It specifies what style parameters are to be copied from the params object.

Return values

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

See also

Paragraph

CFL_prefixed flags

CharParams