Saltar al contenido principal
Proporciona acceso a un campo, su valor y a sus parámetros. El valor de un campo puede modificarse mediante un script. Los scripts también pueden usarse para añadir valores sugeridos que se mostrarán a los operadores de revisión manual.

​
Propiedades

NombreTipoNivel de accesoDescripción
ChildrenField[]De solo lecturaLa matriz de campos secundarios. Esta propiedad solo es válida para campos de grupo.
DataTypeDataTypeDe solo lecturaEl tipo de datos del campo.
FieldTypeFieldTypeDe solo lecturaEl tipo de campo, por ejemplo, texto, casilla de verificación, una tabla (contiene celdas que representan otros campos).
FullNamestringDe solo lecturaLa ruta completa al nombre desde la raíz del documento. Usa una barra diagonal (/) como separador, p. ej., Vendor/Address/Street.
HasRegionboolLectura y escrituraDevuelve true si el campo se ha encontrado en el documento; es decir, existe una región correspondiente en el documento. Un valor de false indica que la imagen del documento no contiene una región que corresponda a este campo.
HasSuspiciousSymbolsboolDe solo lecturaDevuelve true si el valor del campo contiene caracteres reconocidos con baja confianza.
IdstringDe solo lecturaEl identificador del campo, único en el documento.
ImageRegionsImageRegionListLectura y escrituraUna matriz de regiones del campo en la imagen.
InstanceIndexintDe solo lecturaEl índice de la instancia actual del campo repetible. Solo tiene sentido si IsRepeatable es true. Se establece en -1 en todos los demás casos.
InstancesField[]De solo lecturaLa matriz de todas las instancias de este campo. Solo tiene sentido si IsRepeatable es true. La propiedad Instances se puede usar para acceder a instancias de campos repetibles en un contenedor obtenido mediante el método Field GetField.
IsConfirmedboolLectura y escrituraDevuelve true si el campo ha sido verificado por el operador o por una regla de validación.
IsRepeatableboolDe solo lecturaDevuelve true si el campo es repetible.
IsSuspiciousboolDe solo lecturaDevuelve true si algún carácter del valor del campo se ha reconocido con baja confianza. El valor de dicho campo debe revisarse manualmente por un operador o validarse mediante una regla.
IsValidboolDe solo lecturaDevuelve true si el texto reconocido del campo (almacenado en la propiedad Text) se convirtió correctamente al valor del tipo especificado en la propiedad Value.
IsVisibleboolDe solo lecturaDevuelve true si el campo es visible en el documento.
NamestringDe solo lecturaEl nombre del campo, único dentro de su grupo.
ParentFieldDe solo lecturaEl campo principal.
ReadOnlyboolDe solo lecturaDevuelve true si el campo es de solo lectura y no puede ser editado por el operador de revisión manual.
SymbolsSymbol[]De solo lecturaUna matriz de caracteres que conforman el valor original del campo en formato de texto.
TextstringDe solo lecturaEl valor original del campo en formato de texto (generado cuando se reconoce un documento).
ValueobjectLectura y escrituraEl valor del campo en el formato especificado (generado al convertir el texto reconocido). Nota: A diferencia de la propiedad Text, la propiedad Value almacena valores en un formato normalizado. Si el valor normalizado de la propiedad Value se modifica como resultado de ejecutar un script, el valor de la propiedad Text se actualizará con el nuevo valor normalizado. Si el valor normalizado de la propiedad Value no se modifica después de ejecutar el script, el valor de la propiedad Text no se actualizará.

​
Métodos

NombreDescripción
void AddSuggestion(string value);Agrega un valor sugerido para el campo. Este método permite al usuario elegir el valor de la lista de valores sugeridos. Los valores sugeridos se mostrarán durante la revisión manual. Este método no se puede aplicar a grupos de campos ni a contenedores de campos repetitivos.
void CopyTo(Field field);Copia las siguientes propiedades del campo pasado como argumento al campo actual: Text, Value, ImageRegions, Symbols. Si el campo y los tipos de datos del campo no son idénticos, el método devuelve un error.
Field GetChild(string fieldName);Devuelve un campo hijo con el nombre especificado. Este método facilita el acceso a distintos elementos de la misma lista, p. ej., a diferentes celdas de la misma fila. Importante: Pasa directamente a este método el nombre del campo como string: una variable con el mismo valor de cadena no funcionará. El preprocesador que analiza el código del script antes de ejecutarlo reemplazará el nombre del campo por su identificador, pero no podrá procesar una variable.