FieldValue Object (IFieldValue Interface)
This object corresponds to a recognized value of a field. The value contains the data, which type is defined by the Type property. The value of the certain field is accessible through the Value property of the Field object.
Properties
| Name | Type | Description |
|---|---|---|
| AsBoolean | Boolean | Stores the Boolean value. The property is available only if the value of the Type property is FVT_Boolean. |
| AsChoice | FieldChoiceValue, read-only | Stores the field choice value. The property is available only if the value of the Type property is FVT_Choice. |
| AsDateTime | DATE | Stores the date and time value. The property is available only if the value of the Type property is FVT_DateTime. |
| AsDouble | Double | Stores the double value. The property is available only if the value of the Type property is FVT_Number. |
| AsInteger | __int64 | Stores the integer value. The property is available only if the value of the Type property is FVT_Number. |
| AsPicture | FieldPictureValue, read-only | Stores the field picture value. The property is available only if the value of the Type property is FVT_Picture. |
| AsString | String, read-only | Stores the value in string format. |
| AsText | Text, read-only | Stores the text value. The property is available only if the value of the Type property is FVT_Text, FVT_DateTime, FVT_Number, FVT_Currency. |
| Errors | StringsCollection, read-only | Stores the errors received when applying field rules. |
| IsSuspicious | Boolean, read-only | Specifies whether the field value is uncertainly recognized. |
| IsValid | Boolean, read-only | Specifies whether the field value is valid (checks its type). |
| IsVerified | Boolean, read-only | Specifies if the field value had been verified. The property cannot be changed directly but via the SetVerified method. |
| NeedsVerification | Boolean, read-only | Specifies whether the field value is needed to be verified. |
| Type | FieldValueTypeEnum, read-only | Returns the type of the field value. |
| Warnings | StringsCollection, read-only | Stores the warnings received during recognition and applying field rules. |
Methods
| Name | Description |
|---|---|
| SetVerified | Sets the IsVerified property to TRUE. |
Related objects
Output parameter
This object is the output parameter of the Item method of the FieldValuesCollection object.
Input parameter
This object is the input parameter of the Add method of the FieldValuesCollection object.
See also
15.08.2023 13:19:30