Pular para o conteúdo principal
Fornece acesso a um campo, ao seu valor e aos parâmetros. O valor de um campo pode ser modificado por meio de um script. Scripts também podem ser usados para adicionar valores sugeridos a serem exibidos aos operadores de revisão manual.

​
Propriedades

NomeTipoNível de acessoDescrição
ChildrenField[]Somente leituraA matriz de campos filhos. Esta propriedade só é válida para campos de grupo.
DataTypeDataTypeSomente leituraO tipo de dado no campo.
FieldTypeFieldTypeSomente leituraO tipo do campo, por exemplo, texto, marca de seleção ou uma tabela (contém células que representam outros campos).
FullNamestringSomente leituraO caminho completo para o nome a partir da raiz do documento. Usa uma barra (/) como separador, por exemplo: Vendor/Address/Street.
HasRegionboolLeitura e gravaçãoRetorna true se o campo tiver sido encontrado no documento, ou seja, existir uma região correspondente no documento. Um valor false indica que a imagem do documento não contém uma região que corresponda a este campo.
HasSuspiciousSymbolsboolSomente leituraRetorna true se o valor do campo contiver caracteres reconhecidos com baixa confiança.
IdstringSomente leituraO identificador do campo, exclusivo no documento.
ImageRegionsImageRegionListLeitura e gravaçãoUma matriz de regiões do campo na imagem.
InstanceIndexintSomente leituraO índice da instância atual do campo repetível. Só faz sentido se IsRepeatable for true. Definido como -1 em todos os demais casos.
InstancesField[]Somente leituraA matriz de todas as instâncias deste campo. Só faz sentido se IsRepeatable for true. A propriedade Instances pode ser usada para acessar instâncias de campos repetíveis em um contêiner obtido usando o método Field GetField.
IsConfirmedboolLeitura e gravaçãoRetorna true se o campo tiver sido verificado pelo operador ou por uma regra de validação.
IsRepeatableboolSomente leituraRetorna true se o campo for repetível.
IsSuspiciousboolSomente leituraRetorna true se quaisquer caracteres do valor do campo tiverem sido reconhecidos com baixa confiança. O valor de tal campo deve ser revisado manualmente por um operador ou verificado por uma regra.
IsValidboolSomente leituraRetorna true se o texto reconhecido do campo — armazenado na propriedade Text — tiver sido convertido com sucesso no valor do tipo especificado na propriedade Value.
IsVisibleboolSomente leituraRetorna true se o campo estiver visível no documento.
NamestringSomente leituraO nome do campo, exclusivo dentro do seu grupo.
ParentFieldSomente leituraO campo pai.
ReadOnlyboolSomente leituraRetorna true se o campo for somente leitura e não puder ser editado pelo operador de revisão manual.
SymbolsSymbol[]Somente leituraUma matriz de caracteres que formam o valor original do campo em formato de texto.
TextstringSomente leituraO valor original do campo em formato de texto (gerado quando um documento é reconhecido).
ValueobjectLeitura e gravaçãoO valor do campo no formato especificado (gerado ao converter o texto reconhecido). Observação: Diferentemente da propriedade Text, a propriedade Value armazena valores em um formato normalizado. Se o valor normalizado da propriedade Value for modificado como resultado da execução de um script, o valor da propriedade Text será atualizado com o novo valor normalizado. Se o valor normalizado da propriedade Value permanecer inalterado após a execução do script, o valor da propriedade Text não será atualizado.

​
Métodos

NomeDescrição
void AddSuggestion(string value);Adiciona um valor sugerido ao campo. Esse método permite que o usuário escolha um valor na lista de valores sugeridos. Os valores sugeridos serão exibidos durante a revisão manual. Este método não pode ser aplicado a grupos de campos nem a contêineres de campos repetíveis.
void CopyTo(Field field);Copia as seguintes propriedades do Field passado como argumento para o Field atual: Text, Value, ImageRegions, Symbols. Se os tipos do Field e dos dados do Field não forem idênticos, o método retorna um erro.
Field GetChild(string fieldName);Retorna um campo filho com o nome especificado. Esse método facilita o acesso a diferentes elementos da mesma lista, por exemplo, células diferentes na mesma linha. Importante! Passe diretamente para este método o nome do campo como string: uma variável com o mesmo valor de string não funcionará. O pré-processador que analisa o código do script antes da execução substituirá o nome do campo por seu identificador, mas não conseguirá processar uma variável.