IField - ABBYY Documentation

Un campo del documento. El tipo del campo se puede determinar a partir de la propiedad Type. Para los campos de tabla, están disponibles los métodos de objeto Rows y Cell.

Métodos

Método	Descripción
`AddRegion( page : IPage, rect : string ) : IFieldRegion`	Agrega una región con las coordenadas especificadas al campo. `rect` es una descripción de un rectángulo con el formato `[left,top,right,bottom]`. Este método requiere permisos de escritura para el objeto `IField`. Este método no está disponible para tablas. Para eliminar una región, use el método `Delete()` de IFieldRegion. Para ver un ejemplo, consulte Copiar una región de campo.
`Cell( columnName : string, rowNum : int ) : IField`	Recupera una celda de una tabla por el nombre de columna y el número de fila. Disponible solo para tablas. No está disponible en las reglas de script.
`CheckRules( )`	Comprueba las reglas del campo especificado y sus elementos secundarios. No se puede usar en reglas.
`Field( Path : string ) : IField`	Busca un elemento secundario relativo al elemento especificado. Se usan rutas relativas. En las reglas, solo se pueden usar sinónimos de nombres de campo tal como se definen en la configuración de reglas.
`GetFieldExtractor( )`	Devuelve un objeto IFieldExtractor.
`GetLangs( ) : IVARIANTArray`	Devuelve los ID de los idiomas detectados en un campo. Para ver un ejemplo, consulte Comprobar los idiomas en un campo.
`HasField( parameter : string ) : bool`	Comprueba si existe un campo con la ruta especificada. Se usan rutas relativas. En las reglas, solo se pueden usar sinónimos de nombres de campo tal como se definen en la configuración de reglas.
`Suggest( VARIANT newSuggest )`	Agrega una sugerencia al campo. Puede ser un valor o una cadena. Los valores agregados se escriben con cuatro decimales. Por ejemplo, `field.Suggest( "12.90" )` agrega la sugerencia como `12.90`, mientras que `field.Suggest( 12.90 )` la agrega como `12.9000`.

Propiedades

Name	Tipo	Acceso	Descripción
Título	cadena	De solo lectura	El nombre del campo que se muestra en el formulario. El valor de esta propiedad puede coincidir con el de la propiedad Name.
Elementos secundarios	IFields	De solo lectura	Elementos secundarios del campo (celdas en las tablas). No disponible en las reglas de script.
FullName	cadena	De solo lectura	Nombre completo del campo dentro del documento. Identificador único del campo en el documento. Se puede usar para buscar campos de documento mediante el método Field. En las reglas de script, el valor devuelto coincide con Name y no es único.
HasRuleError	bool	Lectura/escritura	Especifica si el campo está asociado a una advertencia o un error de regla. En las reglas de script, esta propiedad determina si se muestra el campo en el mensaje de error. Una regla incluye una colección de campos especificados en el cuadro de diálogo Propiedades de regla. Si falla la comprobación de reglas, el editor de documentos muestra el mensaje de error de `ErrorMessage` de IRuleContext. También muestra enlaces a los campos de la colección. Al establecer esta propiedad en `false`, el campo se excluye de la lista de enlaces asociados al error.
IsExportable	bool	De solo lectura	Indica si el campo está destinado a la exportación (según la configuración de Definición de Document).
IsIndexed	bool	De solo lectura	Especifica si el campo se puede indexar. De ser así, el valor del campo estará disponible en los campos externos del documento y de la página de la Definición de Document.
IsMatched	bool	De solo lectura	Especifica si el campo está emparejado.
IsSuspicious	bool	De solo lectura	Especifica si el valor del campo se ha reconocido con certeza.
IsValid	bool	De solo lectura	Especifica si el campo no presenta errores de formato.
IsVerified	bool	Lectura/escritura	Especifica si el campo se ha verificado. Esta propiedad no funciona con los grupos de campos. La propiedad puede establecerse en `true` mediante reglas incluso sin permisos de escritura para el campo. Para desmarcar el indicador, se requieren permisos de escritura. Si el indicador es `true`, el campo se muestra en gris en el editor de documentos, como si ya estuviera confirmado. Si el indicador es `false`, el campo se muestra en blanco y debe confirmarse. Después de verificar el campo, el indicador se establece en `true`. Establecer este indicador en `false` no envía el campo a la etapa de verificación de datos. Para ello, use la propiedad `NeedVerification` de las interfaces `IField` o ICharacterParams.
IsVisible	bool	Lectura/escritura	Especifica si el campo debe mostrarse en el diseño del documento (según la configuración de Definición de Document).
Elementos	IFields	De solo lectura	Instancias del campo (filas de campos de tabla).
Nombre	cadena	De solo lectura	El nombre del campo en la Definición de Document.
NeedVerification	bool	Lectura/escritura	Especifica si el campo en sí, y no sus caracteres, requiere verificación. Si la marca tiene el valor `true`, el campo se muestra con fondo rojo en el editor de documentos, lo que indica que requiere verificación. Si se selecciona la opción Enviar a verificación de campos en las propiedades del campo, el campo se envía a la etapa de verificación de datos. Después de verificar el campo, la marca se establece en `false`. Para especificar si determinados caracteres, pero no todo el campo, requieren verificación, use la propiedad `NeedVerification` de la interfaz ICharacterParams.
ReadOnly	bool	De solo lectura	Especifica si el campo tiene permisos de solo lectura (según la configuración de Definición de Document). Cuando se utiliza en reglas, indica que la regla tiene permiso de escritura para el campo.
ReadOnlyInForm	bool	Lectura/escritura	Especifica si el campo del formulario tiene permisos de solo lectura (según la Configuración de Definición de Document).
Regiones	IFieldRegions	De solo lectura	Un array de regiones de campo. Los campos que se desbordan pueden tener varias regiones. Disponible solo si está seleccionada la opción Advanced XML Export en las propiedades de la licencia.
Filas	IFields	De solo lectura	Un conjunto de filas de tabla. No disponible para campos que no son de tabla.
Símbolos	ICharactersParams	De solo lectura	Información detallada sobre las propiedades de los símbolos.
Texto	cadena	Lectura/escritura	La representación textual del valor de un campo.
Tipo	TExportFieldType	De solo lectura	El tipo de un campo.
Value	VARIANT	Lectura/escritura	El valor del campo en formato VARIANT. La propiedad devuelve un objeto `Int32` cuando la configuración del campo indica que contiene un entero cuyo valor absoluto no supera `2147483647`. Si el valor absoluto del campo supera `2147483647`, la propiedad devuelve un objeto de tipo double.

Copiar una región de campo

El siguiente código copia la región del campo 1 al campo 2:

field2.AddRegion( field1.Regions[0].Page, field1.Regions[0].SurroundingRect.ToString() )

Compruebe los idiomas en un campo

El siguiente script de usuario comprueba qué idiomas están presentes en un campo:

var t = Context.Field("Field Name").GetLangs();
var p = "";
foreach (var s in t)
{
p += s.ToString()+",";
}
FCTools.ShowMessage( "Language " +  p);