Skip to content

Commit 20fcd44

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #30 from dynamsoft-docs/preview
update to internal commit 31df896f
2 parents 27800a2 + 865da3c commit 20fcd44

7 files changed

Lines changed: 347 additions & 96 deletions

File tree

‎programming/dotnet/api-reference/code-parser-module.md‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,8 @@ The `CodeParserModule` class defines general functions in the code parser module
1414

1515
*Namespace:* Dynamsoft.DCP
1616

17-
*Assembly:* Dynamsoft.CodeParser.dll
18-
19-
2017
```csharp
21-
public class CodeParserModule
18+
public static class CodeParserModule
2219
```
2320

2421
## Methods

‎programming/dotnet/api-reference/enum-mapping-status.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: default-layout
3+
title: MappingStatus - Dynamsoft Code Parser .NET Enumerations
4+
description: The enumeration MappingStatus represents the outcome of a mapping operation on a field for .NET Edition.
5+
keywords: Mapping status
6+
---
7+
8+
# Enumeration MappingStatus
9+
10+
`MappingStatus` represents the outcome of a mapping operation on a field.
11+
12+
```csharp
13+
public enum EnumMappingStatus
14+
{
15+
/** The field has no mapping specified. */
16+
MS_NONE,
17+
/** Find a mapping for the field value. */
18+
MS_SUCCEEDED,
19+
/** Failed to find a mapping for the field value. */
20+
MS_FAILED
21+
}
22+
```

‎programming/dotnet/api-reference/enum-validation-status.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: default-layout
3+
title: ValidationStatus - Dynamsoft Code Parser .NET Enumerations
4+
description: The enumeration ValidationStatus describes the outcome of a validation process on a field for .NET Edition.
5+
keywords: Validation status
6+
---
7+
8+
# Enumeration ValidationStatus
9+
10+
`ValidationStatus` describes the outcome of a validation process on a field.
11+
12+
```csharp
13+
public enum EnumValidationStatus
14+
{
15+
/** The field has no validation specified. */
16+
VS_NONE,
17+
/** The validation for the field has been succeeded. */
18+
VS_SUCCEEDED,
19+
/** The validation for the field has been failed. */
20+
VS_FAILED
21+
}
22+
```

‎programming/dotnet/api-reference/parsed-result-item-v2.4.2000.md‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
---
2+
layout: default-layout
3+
title: ParsedResultItem Class - Dynamsoft Code Parser Module .NET Edition API Reference
4+
description: Definition of the ParsedResultItem class in Dynamsoft Code Parser Module .NET Edition.
5+
keywords: ParsedResultItem, api reference, .NET
6+
needAutoGenerateSidebar: true
7+
---
8+
9+
# ParsedResultItem Class
10+
11+
The `ParsedResultItem` class represents a parsed result item generated by code parser engine.
12+
13+
## Definition
14+
15+
*Namespace:* Dynamsoft.DCP
16+
17+
*Assembly:* Dynamsoft.CodeParser.dll
18+
19+
*Inheritance:* [CapturedResultItem]({{ site.dcvb_dotnet_api }}core/basic-classes/captured-result-item.html) -> ParsedResultItem
20+
21+
```csharp
22+
public class ParsedResultItem
23+
```
24+
25+
## Methods
26+
27+
| Method | Description |
28+
|----------------------|-------------|
29+
| [`Dispose`](#dispose) | Releases all resources used by the `ParsedResultItem` object. |
30+
| [`GetCodeType`](#getcodetype) | Gets the code type of the parsed result. |
31+
| [`GetFieldValue`](#getfieldvalue) | Gets the value of a specified field from the parsed result. |
32+
| [`GetFieldMappingStatus`](#getfieldmappingstatus) | Gets the mapping status of a specified field from the parsed result. |
33+
| [`GetFieldValidationStatus`](#getfieldvalidationstatus) | Gets the validation status of a specified field from the parsed result. |
34+
| [`GetJsonString`](#getjsonstring) | Gets the parsed result as a JSON formatted string. |
35+
| [`GetCapturedResultItemType`](#getcapturedresultitemtype) | Gets the type of the captured result item. |
36+
| [`GetReferenceItem`](#getreferenceitem) | Gets the referenced item in the captured result item. |
37+
38+
### Dispose
39+
40+
Releases all resources used by the `ParsedResultItem` object.
41+
42+
```csharp
43+
void Dispose()
44+
```
45+
46+
### GetCodeType
47+
48+
Gets the code type of the parsed result.
49+
50+
```csharp
51+
string GetCodeType()
52+
```
53+
54+
**Return Value**
55+
56+
Returns a string value representing the code type.
57+
58+
### GetFieldValue
59+
60+
Gets the value of a specified field from the parsed result.
61+
62+
```csharp
63+
string GetFieldValue (string fieldName)
64+
```
65+
66+
**Parameters**
67+
68+
`[in] fieldName` The name of the field.
69+
70+
**Return Value**
71+
72+
Returns a string representing the specified field value.
73+
74+
### GetFieldMappingStatus
75+
76+
Gets the mapping status of a specified field from the parsed result.
77+
78+
```csharp
79+
EnumMappingStatus GetFieldMappingStatus(string fieldName)
80+
```
81+
82+
**Parameters**
83+
84+
`[in] fieldName` The name of the field.
85+
86+
87+
**Return Value**
88+
89+
Returns an `EnumMappingStatus` value representing the mapping status of a specified field.
90+
91+
**See Also**
92+
93+
[EnumMappingStatus]({{ site.dcvb_enumerations }}code-parser/mapping-status.html?lang=dotnet)
94+
95+
### GetFieldValidationStatus
96+
97+
Gets the validation status of a specified field from the parsed result.
98+
99+
```csharp
100+
EnumValidationStatus GetFieldValidationStatus(string fieldName)
101+
```
102+
103+
**Parameters**
104+
105+
`[in] fieldName` The name of the field.
106+
107+
**Return Value**
108+
109+
Returns an `EnumValidationStatus` value representing the validation status of a specified field.
110+
111+
**See Also**
112+
113+
[EnumValidationStatus]({{ site.dcvb_enumerations }}code-parser/validation-status.html?lang=dotnet)
114+
115+
### GetJsonString
116+
117+
Gets the parsed result as a JSON formatted string.
118+
119+
```csharp
120+
string GetJsonString()
121+
```
122+
123+
**Return Value**
124+
125+
Returns a JSON formatted string representing the full parsed result.
126+
127+
### GetCapturedResultItemType
128+
129+
Gets the type of the captured result item.
130+
131+
```csharp
132+
EnumCapturedResultItemType GetCapturedResultItemType()
133+
```
134+
135+
**Return Value**
136+
137+
Returns the type of the captured result item.
138+
139+
**See Also**
140+
141+
[EnumCapturedResultItemType]({{ site.dcvb_enumerations }}core/captured-result-item-type.html?lang=dotnet)
142+
143+
### GetReferenceItem
144+
145+
Gets the referenced item in the captured result item.
146+
147+
```csharp
148+
CapturedResultItem GetReferenceItem()
149+
```
150+
151+
**Return Value**
152+
153+
Returns the referenced item in the captured result item.
154+
155+
**See Also**
156+
157+
[CapturedResultItem]({{ site.dcvb_dotnet_api }}core/basic-classes/captured-result-item.html)

‎programming/dotnet/api-reference/parsed-result-item.md‎

Lines changed: 21 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,24 @@ The `ParsedResultItem` class represents a parsed result item generated by code p
1414

1515
*Namespace:* Dynamsoft.DCP
1616

17-
*Assembly:* Dynamsoft.CodeParser.dll
1817

1918
*Inheritance:* [CapturedResultItem]({{ site.dcvb_dotnet_api }}core/basic-classes/captured-result-item.html) -> ParsedResultItem
2019

2120
```csharp
22-
public class ParsedResultItem
21+
public class ParsedResultItem : CapturedResultItem
2322
```
2423

2524
## Methods
2625

2726
| Method | Description |
2827
|----------------------|-------------|
29-
| [`Dispose`](#dispose) | Releases all resources used by the `ParsedResultItem` object. |
3028
| [`GetCodeType`](#getcodetype) | Gets the code type of the parsed result. |
3129
| [`GetFieldValue`](#getfieldvalue) | Gets the value of a specified field from the parsed result. |
30+
| [`GetFieldRawValue`](#getfieldrawvalue) | Gets the raw value of a specified field from the parsed result. |
3231
| [`GetFieldMappingStatus`](#getfieldmappingstatus) | Gets the mapping status of a specified field from the parsed result. |
3332
| [`GetFieldValidationStatus`](#getfieldvalidationstatus) | Gets the validation status of a specified field from the parsed result. |
3433
| [`GetJsonString`](#getjsonstring) | Gets the parsed result as a JSON formatted string. |
35-
| [`GetCapturedResultItemType`](#getcapturedresultitemtype) | Gets the type of the captured result item. |
36-
| [`GetReferenceItem`](#getreferenceitem) | Gets the referenced item in the captured result item. |
3734

38-
### Dispose
39-
40-
Releases all resources used by the `ParsedResultItem` object.
41-
42-
```csharp
43-
void Dispose()
44-
```
4535

4636
### GetCodeType
4737

@@ -60,7 +50,7 @@ Returns a string value representing the code type.
6050
Gets the value of a specified field from the parsed result.
6151

6252
```csharp
63-
string GetFieldValue (string fieldName)
53+
string GetFieldValue(string fieldName)
6454
```
6555

6656
**Parameters**
@@ -71,6 +61,22 @@ string GetFieldValue (string fieldName)
7161

7262
Returns a string representing the specified field value.
7363

64+
### GetFieldRawValue
65+
66+
Gets the raw value of a specified field from the parsed result.
67+
68+
```csharp
69+
string GetFieldRawValue(string fieldName)
70+
```
71+
72+
**Parameters**
73+
74+
`[in] fieldName` The name of the field.
75+
76+
**Return Value**
77+
78+
Returns a string representing the specified field raw value.
79+
7480
### GetFieldMappingStatus
7581

7682
Gets the mapping status of a specified field from the parsed result.
@@ -90,7 +96,7 @@ Returns an `EnumMappingStatus` value representing the mapping status of a specif
9096

9197
**See Also**
9298

93-
[EnumMappingStatus]({{ site.dcvb_enumerations }}code-parser/mapping-status.html?lang=dotnet)
99+
[EnumMappingStatus]({{ site.dcp_dotnet_api }}enum-mapping-status.html)
94100

95101
### GetFieldValidationStatus
96102

@@ -110,7 +116,7 @@ Returns an `EnumValidationStatus` value representing the validation status of a
110116

111117
**See Also**
112118

113-
[EnumValidationStatus]({{ site.dcvb_enumerations }}code-parser/validation-status.html?lang=dotnet)
119+
[EnumValidationStatus]({{ site.dcp_dotnet_api }}enum-validation-status.html)
114120

115121
### GetJsonString
116122

@@ -124,34 +130,3 @@ string GetJsonString()
124130

125131
Returns a JSON formatted string representing the full parsed result.
126132

127-
### GetCapturedResultItemType
128-
129-
Gets the type of the captured result item.
130-
131-
```csharp
132-
EnumCapturedResultItemType GetCapturedResultItemType()
133-
```
134-
135-
**Return Value**
136-
137-
Returns the type of the captured result item.
138-
139-
**See Also**
140-
141-
[EnumCapturedResultItemType]({{ site.dcvb_enumerations }}core/captured-result-item-type.html?lang=dotnet)
142-
143-
### GetReferenceItem
144-
145-
Gets the referenced item in the captured result item.
146-
147-
```csharp
148-
CapturedResultItem GetReferenceItem()
149-
```
150-
151-
**Return Value**
152-
153-
Returns the referenced item in the captured result item.
154-
155-
**See Also**
156-
157-
[CapturedResultItem]({{ site.dcvb_dotnet_api }}core/basic-classes/captured-result-item.html)

0 commit comments

Comments
 (0)