|
Octobox API
4.1.0
Octobox Scripting API
|
Object containing read only properties of an extraction field. More...
Public Types | |
| enum | FieldTypes { Document, Batch } |
| Enumeration of Field types. More... | |
| enum | SearchTypes { ImportField = -2, FixedValue = -1, BarcodeLocator, FormatLocator, TableLocator, ZoneLocator, DatabaseLocator } |
| Enumeration of Search types. More... | |
| enum | TargetTypes { All = -1, Documents, Body, Subject, BodyAndSubject } |
| Enumeration of Target types. More... | |
Properties | |
| int | AlternativeIndex [get] |
| Field data type of the extraction field. More... | |
| string | DefaultValue [get] |
| Default value of the extraction field. More... | |
| string | Description [get] |
| Description of the extraction field. More... | |
| bool | DistinctValues [get] |
| List of the unique extraction values. More... | |
| FieldTypes | FieldType [get] |
| Field type of the extraction field. More... | |
| string | FixedValue [get] |
| Fixed value of the extraction field. More... | |
| Guid | Id [get] |
| Id of the extraction field. More... | |
| bool | IsRequired [get] |
| Indicates if this extraction field must contain a value. More... | |
| SCLocator | Locator [get] |
| Locator field to use to find the extraction field value. More... | |
| string | LocatorFieldName [get] |
| Name of the locator field. More... | |
| Guid | LocatorId [get] |
| Id of the locator field. More... | |
| int | MaxAlternatives [get] |
| Maximum number of returned alternatives. More... | |
| bool | MergeAlternatives [get] |
| Indicates if to merge the alternatives. More... | |
| string | Name [get] |
| Name of the extraction field. More... | |
| SearchTypes | SearchType [get] |
| Search type to use to find the extraction field. More... | |
| TargetTypes | TargetType [get] |
| Target type to use to find the extraction field. More... | |
Object containing read only properties of an extraction field.
|
strong |
|
strong |
|
strong |
|
get |
Field data type of the extraction field.
Index of the alternative value.
|
get |
Default value of the extraction field.
|
get |
Description of the extraction field.
|
get |
List of the unique extraction values.
|
get |
Field type of the extraction field.
|
get |
Fixed value of the extraction field.
|
get |
Id of the extraction field.
|
get |
Indicates if this extraction field must contain a value.
|
get |
Locator field to use to find the extraction field value.
|
get |
Name of the locator field.
|
get |
Id of the locator field.
|
get |
Maximum number of returned alternatives.
|
get |
Indicates if to merge the alternatives.
|
get |
Name of the extraction field.
|
get |
Search type to use to find the extraction field.
|
get |
Target type to use to find the extraction field.
1.8.13