> ## 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.

# IField

> Referencia del objeto IField para scripts de ABBYY FlexiCapture: permite leer y escribir valores de campos, regiones, símbolos, indicadores de verificación, así como filas y celdas de tabla.

<div id="what-it-does">
  ## Qué hace
</div>

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

<div id="methods">
  ## Métodos
</div>

<table width="100%">
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Definición</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Descripción</strong>
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>
          AddRegion( page : <a href="/es/flexi-capture/appendix/scripts/ipage">IPage</a>, rect : string ) : <a href="/es/flexi-capture/appendix/scripts/ifieldregion">IFieldRegion</a>
        </p>
      </td>

      <td>
        <p>
          Agrega una región con las coordenadas especificadas al campo. <strong>rect</strong> es la descripción de un rectángulo con el formato \[left,top,right,bottom]. Este método requiere permisos de escritura
          para el objeto IField.
        </p>

        <details>
          <summary>Código de ejemplo</summary>
          <p>Ejemplo de código que copia la región del campo 1 al campo 2:</p>

          <pre>
            <code>field2.AddRegion( field1.Regions\[0].Page, field1.Regions\[0].SurroundingRect.ToString() )</code>
          </pre>
        </details>

        <p>
          <strong>Nota: </strong> Este método no está disponible para tablas. Para eliminar una región, use el método <a href="/es/flexi-capture/appendix/scripts/ifieldregion">IFieldRegion</a>.Delete().
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Cell( columnName : string, rowNum : int ) : IField</p>
      </td>

      <td>
        <p>Obtiene una celda de tabla por el nombre de la columna y el número de fila. Disponible solo para tablas. No está disponible en reglas de script.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>CheckRules( )</p>
      </td>

      <td>
        <p>Comprueba las reglas del campo especificado y de sus elementos secundarios. No se puede usar en reglas.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Field( Path : string) : IField</p>
      </td>

      <td>
        <p>
          Busca el elemento secundario relativo al elemento dado. Se usan <a href="/es/flexi-capture/appendix/scripts/scripting-model#pathforming">rutas relativas</a>. En las reglas, solo se pueden usar sinónimos de nombres de campo
          tal como están definidos en la configuración de reglas.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>GetFieldExtractor( )</p>
      </td>

      <td>
        <p>
          Devuelve un objeto <a href="/es/flexi-capture/i-field-extractor">IFieldExtractor</a>.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>GetLangs() : IVARAIANTArray</p>
      </td>

      <td>
        <p>Devuelve los ID de los idiomas detectados en un campo.</p>

        <details>
          <summary>Ejemplo</summary>

          <p>
            Ejemplo de un <a href="/es/flexi-capture/templates/properties-custom-action">script de usuario</a> que comprueba qué idiomas están presentes en un campo:
          </p>

          <pre>
            <code>var t = Context.Field("Field Name").GetLangs(); var p = ""; foreach (var s in t) \{ p += s.ToString()+","; } FCTools.ShowMessage( "Language " +  p);</code>
          </pre>
        </details>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasField( parameter : string) : bool</p>
      </td>

      <td>
        <p>
          Comprueba si existe el campo con la ruta especificada. Se usan <a href="/es/flexi-capture/appendix/scripts/scripting-model#pathforming">rutas relativas</a>. En las reglas, solo se pueden usar sinónimos de nombres de campo tal
          como están definidos en la configuración de reglas.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Suggest( VARIANT newSuggest )</p>
      </td>

      <td>
        <p>Agrega una sugerencia al campo.</p>

        <p>
          <strong>Nota: </strong> Puede ser un valor o una cadena. Los valores agregados se escriben con cuatro decimales.
        </p>

        <p>Por ejemplo, el método field.Suggest( "12.90" ) agrega la sugerencia con el formato "12.90", mientras que field.Suggest( 12.90 ) agrega la sugerencia como 12.9000.</p>
      </td>
    </tr>
  </tbody>
</table>

<div id="properties">
  ## Propiedades
</div>

<table width="100%">
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Name</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Tipo</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Acceso</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Descripción</strong>
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>Etiqueta</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>
          El nombre del campo que se muestra en el formulario. El valor de esta propiedad puede ser el mismo que el de la propiedad <a href="/es/flexi-capture/appendix/scripts/ifield#propertyname">Name</a>.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Elementos secundarios</p>
      </td>

      <td>
        <p>
          <a href="/es/flexi-capture/appendix/scripts/ifields">IFields</a>
        </p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Elementos secundarios del campo (celdas en tablas). No disponible en reglas de script.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>FullName</p>
      </td>

      <td>
        <p>cadena</p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>
          El nombre completo del campo en relación con el documento. Es un identificador único del campo dentro del documento. Puede usarse para buscar campos del documento mediante el método{" "}
          <a href="/es/flexi-capture/appendix/scripts/scripting-model#pathforming">Field</a>. En las reglas de script, el valor devuelto coincide con{" "}
          <a href="/es/flexi-capture/appendix/scripts/ifield#propertyname">Name</a> y no es único.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasRuleError</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Lectura/escritura</p>
      </td>

      <td>
        <p>Especifica si hay una advertencia o un error de regla asociado al campo.</p>

        <p>
          <strong>Nota: </strong> En las reglas de script, esta propiedad especifica si se debe mostrar el campo en el mensaje de error.
        </p>

        <p>
          Una regla incluye una colección de campos especificados en el <a href="/es/flexi-capture/templates/rule-script">cuadro de diálogo de propiedades de la regla</a>cuadro de diálogo de propiedades de la regla. Si falla la comprobación de la regla, un mensaje de error
          (especificado en <a href="/es/flexi-capture/appendix/scripts/irulecontext">IRuleContext</a>
          <strong>.ErrorMessage</strong>) y enlaces a los campos de la colección se muestran en el editor de documentos. Establecer esta propiedad en <strong>false</strong> excluye el campo de la
          lista de enlaces asociados al error.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsExportable</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Especifica si el campo está previsto para la exportación (según la configuración de Definición de Document).</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsIndexed</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Especifica si el campo se puede indexar. Si es así, el valor del campo puede estar disponible en los campos externos del documento y de la página de la Definición de Document.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsMatched</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Indica si el campo está emparejado.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsSuspicious</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Indica si el valor del campo se ha reconocido con certeza.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsValid</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Indica si el campo no tiene errores de formato.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsVerified</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Lectura/escritura</p>
      </td>

      <td>
        <p>
          Especifica si el campo está verificado. <br />
          <strong>Nota: </strong> La propiedad no funciona para <a href="/es/flexi-capture/templates/field-group">grupos de campos</a>grupos de campos.

          <br />

          La propiedad puede establecerse en <strong>true</strong> en las reglas incluso sin permisos de "escritura" para el campo. Para desactivar el indicador, se requieren permisos de "escritura".
        </p>

        <p>
          Si el indicador es <strong>true</strong>, el campo se muestra en gris en el editor de documentos, como si ya estuviera confirmado. Si el indicador es <strong>false</strong>, el campo se muestra en blanco
          y debe confirmarse. Una vez que el campo se verifica, el indicador se establece en <strong>true</strong>.
        </p>

        <p>
          <strong>Nota: </strong> Establecer este indicador en <strong>false</strong> no envía el campo a la etapa de Verificación de datos. Para ello, use la propiedad <strong>NeedVerification</strong>{" "}
          de las interfaces IField o <a href="/es/flexi-capture/appendix/scripts/icharacterparams">ICharacterParams</a>.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsVisible</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Lectura/escritura</p>
      </td>

      <td>
        <p>Especifica si el campo debe mostrarse en el diseño del documento (según la Configuración de Definición de Document).</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Elementos</p>
      </td>

      <td>
        <p>
          <a href="/es/flexi-capture/appendix/scripts/ifields">IFields</a>
        </p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Instancias del campo (filas de los campos de tabla).</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <a id="propertyname" />Name
        </p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>El nombre del campo en la Definición de Documentos.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>NeedVerification</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Lectura/escritura</p>
      </td>

      <td>
        <p>Especifica si el campo en sí (no sus caracteres) necesita verificación.</p>

        <p>
          Si la marca es <strong>true</strong>, el campo se muestra sobre un fondo rojo en el editor de documentos, lo que indica que el campo necesita verificación. Si la opción Send to field verification
          está seleccionada en las <a href="/es/flexi-capture/templates/properties-verification">propiedades del campo</a>propiedades del campo, el campo se enviará a la etapa de Verificación de datos. Una vez verificado el
          campo, la marca se establece en <strong>false</strong>.
        </p>

        <p>
          Para especificar si determinados caracteres, pero no el campo completo, necesitan verificación, use la propiedad <strong>NeedVerification</strong> de la{" "}
          <a href="/es/flexi-capture/appendix/scripts/icharacterparams">ICharacterParams</a> interfaz.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ReadOnly</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>
          Especifica si el campo tiene permisos "de solo lectura" (según la Configuración de Definición de Document). Cuando se usa en las reglas, indica que la regla tiene permiso de "escritura" para el campo.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ReadOnlyInForm</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Lectura/escritura</p>
      </td>

      <td>
        <p>Especifica si el campo del formulario tiene permisos de "solo lectura" (según la Configuración de Definición de Document).</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          Regiones<a href="#condition">\*\*</a>
        </p>
      </td>

      <td>
        <p>
          <a href="/es/flexi-capture/appendix/scripts/ifieldregions">IFieldRegions</a>
        </p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Un array de regiones de campo. Los campos que se desbordan pueden tener varias regiones.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Filas</p>
      </td>

      <td>
        <p>
          <a href="/es/flexi-capture/appendix/scripts/ifields">IFields</a>
        </p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Un conjunto de filas de una tabla. No disponible para campos que no son de tabla.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Símbolos</p>
      </td>

      <td>
        <p>
          <a href="/es/flexi-capture/appendix/scripts/icharactersparams">ICharactersParams</a>
        </p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>Información detallada sobre las propiedades de los símbolos.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Text</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>Lectura y escritura</p>
      </td>

      <td>
        <p>La representación textual del valor de un campo.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Tipo</p>
      </td>

      <td>
        <p>
          <a href="/es/flexi-capture/appendix/scripts/texportfieldtype">TExportFieldType</a>
        </p>
      </td>

      <td>
        <p>De solo lectura</p>
      </td>

      <td>
        <p>El tipo del campo.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Value</p>
      </td>

      <td>
        <p>VARIANT</p>
      </td>

      <td>
        <p>Lectura/escritura</p>
      </td>

      <td>
        <p>
          El valor del campo en formato VARIANT. La propiedad devuelve un objeto de tipo Int32 si la configuración del campo indica que contiene un entero y su valor absoluto no es
          superior a 2147483647. Si el valor absoluto del campo es superior a 2147483647, la propiedad devuelve un objeto de tipo double.
        </p>
      </td>
    </tr>
  </tbody>
</table>

<a id="condition" />\*\* - La propiedad no está disponible si la opción Advanced XML Export de las propiedades de License no está seleccionada.