Vai al contenuto principale
Fornisce accesso a un field, al suo valore e ai relativi Parameter. Il valore di un field può essere modificato tramite script. Gli script possono anche essere utilizzati per aggiungere valori suggeriti da mostrare agli operatori di revisione manuale.

Proprietà

NomeTipoLivello di accessoDescrizione
ChildrenField[]Sola letturaL’array dei field figlio. Questa proprietà è valida solo per i field di tipo gruppo.
DataTypeDataTypeSola letturaIl tipo di dati nel field.
FieldTypeFieldTypeSola letturaIl tipo di field, ad esempio testo, casella di spunta, tabella (contiene celle che rappresentano altri field).
FullNamestringSola letturaIl percorso completo del nome a partire dalla radice del documento. Usa una barra (/) come separatore, ad es. Vendor/Address/Street.
HasRegionboolLettura-scritturaRestituisce true se il field è stato trovato nel documento, cioè esiste una regione corrispondente nel documento. Un valore false indica che l’immagine del documento non contiene una regione corrispondente a questo field.
HasSuspiciousSymbolsboolSola letturaRestituisce true se il valore del field contiene caratteri riconosciuti con bassa affidabilità.
IdstringSola letturaL’identificatore del field, univoco nel documento.
ImageRegionsImageRegionListLettura-scritturaUn array di regioni del field sull’immagine.
InstanceIndexintSola letturaL’indice dell’istanza corrente del field ripetuto. Ha senso solo se IsRepeatable è true. Impostato a -1 in tutti gli altri casi.
InstancesField[]Sola letturaL’array di tutte le istanze di questo field. Ha senso solo se IsRepeatable è true. La proprietà Instances può essere usata per accedere alle istanze del field ripetuto in un contenitore ottenuto usando il metodo Field GetField.
IsConfirmedboolLettura-scritturaRestituisce true se il field è stato verificato dall’operatore o da una regola di convalida.
IsRepeatableboolSola letturaRestituisce true se il field è ripetuto.
IsSuspiciousboolSola letturaRestituisce true se alcuni caratteri del valore del field sono stati riconosciuti con bassa affidabilità. Il valore di tale field dovrebbe essere sottoposto a revisione manuale da un operatore o verificato da una regola.
IsValidboolSola letturaRestituisce true se il testo riconosciuto del field - memorizzato nella proprietà Text - è stato convertito correttamente nel valore del tipo specificato nella proprietà Value.
IsVisibleboolSola letturaRestituisce true se il field è visibile nel documento.
NamestringSola letturaIl nome del field, univoco all’interno del suo gruppo.
ParentFieldSola letturaIl field padre.
ReadOnlyboolSola letturaRestituisce true se il field è di sola lettura e non può essere modificato dall’operatore di revisione manuale.
SymbolsSymbol[]Sola letturaUn array di caratteri che costituiscono il valore originale del field in formato testo.
TextstringSola letturaIl valore originale del field in formato testo (generato quando un documento viene riconosciuto).
ValueobjectLettura-scritturaIl valore del field nel formato specificato (generato durante la conversione del testo riconosciuto). Nota: A differenza della proprietà Text, la proprietà Value memorizza i valori in un formato normalizzato. Se il valore normalizzato della proprietà Value viene modificato a seguito dell’esecuzione di uno script, il valore della proprietà Text verrà aggiornato con il nuovo valore normalizzato. Se il valore normalizzato della proprietà Value rimane invariato dopo l’esecuzione dello script, il valore della proprietà Text non verrà aggiornato.

Metodi

NomeDescrizione
void AddSuggestion(string value);Aggiunge un valore suggerito per il field. Questo metodo consente all’utente di scegliere il valore dall’elenco dei valori suggeriti. I valori suggeriti verranno visualizzati durante la revisione manuale. Questo metodo non può essere applicato ai gruppi di field e ai container di field ripetuti.
void CopyTo(Field field);Copia le seguenti proprietà del field passato come argomento nel field corrente: Text, Value, ImageRegions, Symbols. Se i tipi del field e dei relativi dati non sono identici, il metodo restituisce un errore.
Field GetChild(string fieldName);Restituisce un field figlio con il nome specificato. Questo metodo semplifica l’accesso a diversi elementi dello stesso elenco, ad es. celle diverse nella stessa riga. Importante! Passa direttamente a questo metodo il nome string del field: una variabile con lo stesso valore string non funzionerà. Il preprocessore che analizza lo script prima dell’esecuzione sostituirà il nome del field con il suo identificatore, ma non sarà in grado di elaborare una variabile.