Skip to content

Commit fb25725

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #46 from dynamsoft-docs/preview
update to internal commit 74705ebd
2 parents 73d14bd + d550375 commit fb25725

File tree

2 files changed

+102
-55
lines changed

2 files changed

+102
-55
lines changed

‎programming/maui/api-reference/recognized-text-lines-result-v2.6.1001.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
layout: default-layout
3+
title: RecognizedTextLinesResult - Dynamsoft Capture Vision MAUI Edition
4+
description: The class RecognizedTextLinesResult of Dynamsoft Capture Vision MAUI edition represents the result of a text recognition process.
5+
keywords: Recognized text lines result
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: RecognizedTextLinesResult
10+
---
11+
12+
# RecognizedTextLinesResult
13+
14+
The `RecognizedTextLinesResult` class represents the overall result(s) of a text recognition process. It provides access to information about the recognized text lines, the original image, and any errors that occurred during the recognition process.
15+
16+
## Definition
17+
18+
*Namespace:* Dynamsoft.LabelRecognizer.Maui
19+
20+
*Assembly:* Dynamsoft.LabelRecognizer.Maui
21+
22+
```csharp
23+
class RecognizedTextLinesResult
24+
```
25+
26+
## Properties
27+
28+
| Property | Type | Description |
29+
| -------- | ---- | ----------- |
30+
| [`OriginalImageHashId`](#originalimagehashid) | *String* | Gets the hash ID of the original image. |
31+
| [`Items`](#items) | *IList<TextLineResultItem>* | Gets the text line result item at the specified index. |
32+
| [`RotationTransformMatrix`](#rotationtransformmatrix) | *Matrix* | Get the rotation transformation matrix of the original image relative to the rotated image.|
33+
| [`ErrorCode`](#errorcode) | *int* | Gets the error code of the recognition result, if an error occurred. |
34+
| [`ErrorMessage`](#errormessage) | *String* | Gets the error message of the recognition result, if an error occurred. |
35+
36+
### OriginalImageHashId
37+
38+
Get the hash id of the original image. You can use this ID to get the original image via the [`IntermediateResultManager`]({{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html) class.
39+
40+
```csharp
41+
String OriginalImageHashId { get; }
42+
```
43+
44+
**Return value**
45+
46+
Returns the hash ID of the original image as a string.
47+
48+
### Items
49+
50+
Gets all the text line result(s) recognized from the image/frame in an array of [`DSTextLineResultItem`](text-line-result-item.md).
51+
52+
```csharp
53+
IList<TextLineResultItem> Items { get; }
54+
```
55+
56+
**Return value**
57+
58+
Returns an array of `TextLineResultItem` that contains all text line recognition results.
59+
60+
### RotationTransformMatrix
61+
62+
Get the rotation transformation matrix of the original image relative to the rotated image.
63+
64+
```csharp
65+
Matrix RotationTransformMatrix { get; }
66+
```
67+
68+
**Return Value**
69+
70+
A `Matrix` which represents the rotation transform matrix.
71+
72+
### ErrorCode
73+
74+
Gets the error code of the recognition result, if an error occurred.
75+
76+
```csharp
77+
int ErrorCode { get; }
78+
```
79+
80+
**Return value**
81+
82+
Returns the error code of the recognition result, or 0 if no error occurred.
83+
84+
### ErrorMessage
85+
86+
Gets the error message of the recognition result, if an error occurred.
87+
88+
```csharp
89+
String ErrorMessage { get; }
90+
```
91+
92+
**Return value**
93+
94+
Returns a string that describes the error message.

‎programming/maui/api-reference/recognized-text-lines-result.md‎

Lines changed: 8 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -20,30 +20,23 @@ The `RecognizedTextLinesResult` class represents the overall result(s) of a text
2020
*Assembly:* Dynamsoft.LabelRecognizer.Maui
2121

2222
```csharp
23-
class RecognizedTextLinesResult
23+
class RecognizedTextLinesResult : CapturedResultBase
2424
```
2525

2626
## Properties
2727

2828
| Property | Type | Description |
2929
| -------- | ---- | ----------- |
30-
| [`OriginalImageHashId`](#originalimagehashid) | *String* | Gets the hash ID of the original image. |
3130
| [`Items`](#items) | *IList<TextLineResultItem>* | Gets the text line result item at the specified index. |
32-
| [`RotationTransformMatrix`](#rotationtransformmatrix) | *Matrix* | Get the rotation transformation matrix of the original image relative to the rotated image.|
33-
| [`ErrorCode`](#errorcode) | *int* | Gets the error code of the recognition result, if an error occurred. |
34-
| [`ErrorMessage`](#errormessage) | *String* | Gets the error message of the recognition result, if an error occurred. |
3531

36-
### OriginalImageHashId
32+
The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_maui_api }}core/captured-result-base.html):
3733

38-
Get the hash id of the original image. You can use this ID to get the original image via the [`IntermediateResultManager`]({{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html) class.
39-
40-
```csharp
41-
String OriginalImageHashId { get; }
42-
```
43-
44-
**Return value**
45-
46-
Returns the hash ID of the original image as a string.
34+
| Property | Type | Description |
35+
| -------- | ---- | ----------- |
36+
| [`OriginalImageHashId`]({{ site.dcv_maui_api }}core/captured-result-base.html#originalimagehashid) | *string* | Represents the hash id of the original image. |
37+
| [`RotationTransformMatrix`]({{ site.dcv_maui_api }}core/captured-result-base.html#rotationtransformmatrix) | *Matrix* | Represents the rotation transformation matrix of the original image relative to the rotated image. |
38+
| [`ErrorCode`]({{ site.dcv_maui_api }}core/captured-result-base.html#errorcode) | *int* | Represents the error code of this result. |
39+
| [`ErrorMessage`]({{ site.dcv_maui_api }}core/captured-result-base.html#errormessage) | *string* | Represents the error message of this result. |
4740

4841
### Items
4942

@@ -52,43 +45,3 @@ Gets all the text line result(s) recognized from the image/frame in an array of
5245
```csharp
5346
IList<TextLineResultItem> Items { get; }
5447
```
55-
56-
**Return value**
57-
58-
Returns an array of `TextLineResultItem` that contains all text line recognition results.
59-
60-
### RotationTransformMatrix
61-
62-
Get the rotation transformation matrix of the original image relative to the rotated image.
63-
64-
```csharp
65-
Matrix RotationTransformMatrix { get; }
66-
```
67-
68-
**Return Value**
69-
70-
A `Matrix` which represents the rotation transform matrix.
71-
72-
### ErrorCode
73-
74-
Gets the error code of the recognition result, if an error occurred.
75-
76-
```csharp
77-
int ErrorCode { get; }
78-
```
79-
80-
**Return value**
81-
82-
Returns the error code of the recognition result, or 0 if no error occurred.
83-
84-
### ErrorMessage
85-
86-
Gets the error message of the recognition result, if an error occurred.
87-
88-
```csharp
89-
String ErrorMessage { get; }
90-
```
91-
92-
**Return value**
93-
94-
Returns a string that describes the error message.

0 commit comments

Comments
 (0)