Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Field proporciona acceso a un campo del documento: su valor, parámetros y estructura. Desde un script, puede modificar el valor de un campo o agregar valores sugeridos que se muestran a los operadores de revisión manual.

​
Propiedades

​
Children

Tipo: Field[] — Acceso: De solo lectura El array de campos secundarios. Válido solo para campos de grupo.

​
DataType

Tipo: DataType — Acceso: De solo lectura El tipo de datos del campo.

​
FieldType

Type: FieldType — Access: De solo lectura El tipo de campo; por ejemplo, texto, marca de verificación o una tabla (que contiene celdas que representan otros campos).

​
FullName

Type: string — Access: De solo lectura La ruta completa al campo desde la raíz del documento. Usa una barra inclinada (/) como separador; por ejemplo, Vendor/Address/Street.

​
HasRegion

Type: bool — Access: Lectura y escritura true si el campo se ha encontrado en el documento (existe una región para él en la imagen). false significa que no se encontró ninguna región correspondiente.

​
HasSuspiciousSymbols

Type: bool — Access: De solo lectura true si el valor del campo contiene caracteres reconocidos con un nivel de confianza bajo.

​
Id

Tipo: string — Acceso: De solo lectura El identificador del campo, único dentro del documento.

​
ImageRegions

Type: ImageRegionList — Access: Lectura y escritura Un array de regiones del campo en la imagen.

​
InstanceIndex

Type: int — Access: De solo lectura El índice de la instancia actual de un campo repetible. Se establece en -1 para los campos no repetibles.

​
Instances

Tipo: Field[] — Acceso: De solo lectura El array de todas las instancias de este campo (solo para campos repetibles). Use Instances para acceder a las instancias de campos repetibles en un contenedor obtenido mediante GetField.

​
IsConfirmed

Type: bool — Access: Lectura y escritura true si el campo ha sido verificado por un operador o por una regla de validación.

​
IsRepeatable

Type: bool — Access: De solo lectura true si el campo es un campo repetible.

​
IsSuspicious

Type: bool — Acceso: De solo lectura true si algún carácter del valor del campo fue reconocido con un nivel de confianza bajo. Estos campos deben revisarse manualmente o comprobarse mediante una regla.

​
IsValid

Type: bool — Access: De solo lectura true si el texto reconocido en Text se convirtió correctamente en un valor del tipo especificado en Value.

​
IsVisible

Tipo: bool — Acceso: De solo lectura true si el campo es visible en el documento.

​
Name

Type: string — Access: De solo lectura El nombre del campo, único dentro de su grupo.

​
Parent

Tipo: Field — Acceso: De solo lectura El campo padre.

​
ReadOnly

Type: bool — Access: De solo lectura true si el campo es de solo lectura y no puede editarse durante la revisión manual.

​
Symbols

Type: Symbol[] — Access: De solo lectura Un array de caracteres que forman el valor original del campo en formato de texto.

​
Text

Tipo: string — Acceso: De solo lectura El valor original del campo en formato de texto (generado cuando se reconoce el documento).

​
Value

Tipo: object — Acceso: Lectura y escritura El valor del campo en el formato especificado (generado al convertir el texto reconocido).
A diferencia de Text, la propiedad Value almacena el valor normalizado. Si un script modifica Value con un valor normalizado diferente, Text se actualiza con la nueva forma normalizada. Si Value no cambia después de que se ejecuta el script, Text no se actualiza.

​
Métodos

​
AddSuggestion

void AddSuggestion(string value);
Agrega un valor sugerido para el campo. Durante la revisión manual, los operadores pueden seleccionarlo de la lista de valores sugeridos.
No se admite en grupos de campos ni en contenedores de campos repetibles.

​
CopyTo

void CopyTo(Field field);
Copia Text, Value, ImageRegions y Symbols del campo del argumento al campo actual. Devuelve un error si los dos campos tienen tipos de datos diferentes.

​
GetChild

Field GetChild(string fieldName);
Devuelve el campo secundario con el nombre especificado. Use GetChild para acceder a elementos de una lista; por ejemplo, a distintas celdas de la misma fila.
Pase el nombre del campo como un literal de cadena, no como una variable. El preprocesador de scripts sustituye el nombre literal por el identificador del campo antes de la ejecución; las variables no se procesan.

Modelo de objetos

Referencia completa de objetos de JavaScript para usar en reglas avanzadas de script.

Context

El objeto global Context: permite acceder al documento, los campos y los parámetros de skill desde una regla.

FieldType

Enumeración de los tipos de campo disponibles y de los tipos de datos que admite cada uno.

DataType

Enumeración de los tipos de datos que puede contener un campo (también incluye AmountOfMoney para valores monetarios).