TextBlock Object (ITextBlock Interface)
This object provides access to specific properties of a text block. These blocks correspond to an image zone recognized as formatted text. The recognized text from the part of the image this block encloses is also accessible via this object. The ITextBlock interface is derived from the IBlock interface and inherits all its properties.
The properties of this object can be divided into two groups:
- the properties which affect the process of text recognition in the block. They are ImageProcessingParams, AnalysisParams and RecognizerParams. These properties let you set special parameters of processing for a single block.
- the properties which can be either set after analysis and before recognition, or filled in by the program during recognition. These include BlockRole and BusinessCardFieldType, used to specify the role of the block in the different types of documents. The TextOrientation property also belongs to this group.
- the recognition results. This group contains only the Text property, which represents the recognized text of the block.
Properties
| Name | Type | Description |
|---|---|---|
| Processing settings | ||
| AnalysisParams | TextBlockAnalysisParams | Provides access to the analysis parameters of the text block. |
| ImageProcessingParams | ImageProcessingParams | Provides access to the image preprocessing parameters of the text block. |
| RecognizerParams | RecognizerParams | Provides access to the recognition parameters of the text block. |
| The role and orientation of the text | ||
| BlockRole | BlockRoleEnum |
Specifies the role of the text block in the logical structure of a document. By default, it is BR_Unknown. |
| BusinessCardFieldType | BusinessCardFieldTypeEnum |
Provides access to the role of the text block as a part of a business card. When the IFRPage::SynthesizeBusinessCard method is called, FineReader Engine presumes the block with the specified role in a business card to be a field of corresponding type. If the block cannot be considered as the field of this type, the text of the block will not appear in the text of the business card. By default, it is BCFT_Unknown. |
| TextOrientation | TextOrientation | Specifies the text orientation in the block. If you set it before recognition it will affect the way the text in the block is interpreted (e.g., in lines or in columns); otherwise, it will contain the detected orientation after recognition. |
| Results of recognition | ||
| Text | Text, read-only | Contains the recognized text of the text block. |
Methods
| Name | Description |
|---|---|
| CopyFrom | Initializes the properties of the current object with the values of similar properties of another object. |
Related objects
Output parameter
This object is the output parameter of the GetAsTextBlock method of the Block object.
Samples
The object is used in the following code samples: CustomLanguage.
See also
03.07.2024 8:50:25