IField - ABBYY Documentation

Un champ de document. Le type du champ peut être déterminé à partir de la propriété Type. Pour les champs de type tableau, les méthodes d’objet Rows et Cell sont disponibles.

Méthodes

Méthode	Description
`AddRegion( page : IPage, rect : string ) : IFieldRegion`	Ajoute une région aux coordonnées spécifiées au champ. `rect` décrit un rectangle au format `[left,top,right,bottom]`. Cette méthode nécessite des autorisations d’écriture sur l’objet `IField`. Cette méthode n’est pas disponible pour les tableaux. Pour supprimer une région, utilisez la méthode `Delete()` de IFieldRegion. Pour un exemple, consultez Copier une région de champ.
`Cell( columnName : string, rowNum : int ) : IField`	Récupère une cellule de tableau à partir du nom de colonne et du numéro de ligne. Disponible uniquement pour les tableaux. Non disponible dans les règles de script.
`CheckRules( )`	Vérifie les règles du champ donné et de ses éléments enfants. Ne peut pas être utilisée dans les règles.
`Field( Path : string ) : IField`	Recherche un élément enfant par rapport à l’élément donné. Des chemins relatifs sont utilisés. Dans les règles, seuls les synonymes des libellés de champs définis dans les paramètres de règle peuvent être utilisés.
`GetFieldExtractor( )`	Renvoie un objet IFieldExtractor.
`GetLangs( ) : IVARIANTArray`	Renvoie les ID des langues détectées dans un champ. Pour un exemple, consultez Vérifier les langues dans un champ.
`HasField( parameter : string ) : bool`	Vérifie si le champ correspondant au chemin spécifié existe. Des chemins relatifs sont utilisés. Dans les règles, seuls les synonymes des libellés de champs définis dans les paramètres de règle peuvent être utilisés.
`Suggest( VARIANT newSuggest )`	Ajoute un prompt au champ. Il peut s’agir d’une valeur ou d’une string. Les valeurs ajoutées sont écrites avec quatre décimales. Par exemple, `field.Suggest( "12.90" )` ajoute le prompt sous la forme `12.90`, tandis que `field.Suggest( 12.90 )` l’ajoute sous la forme `12.9000`.

Propriétés

Nom	Type	Accès	Description
Légende	string	Lecture seule	Nom du champ affiché sur le formulaire. La valeur de cette propriété peut être identique à celle de la propriété Name.
Éléments enfants	IFields	Lecture seule	Éléments enfants du champ (cellules dans le cas des tableaux). Non disponible dans les règles de script.
FullName	string	Lecture seule	Nom complet du champ par rapport au document. Identifiant unique du champ dans le document. Peut être utilisé pour rechercher des champs de document à l’aide de la méthode Field. Dans les règles de script, la valeur renvoyée correspond à Name et n’est pas unique.
HasRuleError	bool	Lecture/écriture	Indique si un avertissement ou une erreur de règle est associé au champ. Dans les règles de script, cette propriété indique si le champ doit être affiché dans le message d’erreur. Une règle inclut une collection de champs spécifiés dans la boîte de dialogue Propriétés de la règle. Si la vérification de la règle échoue, l’éditeur de documents affiche le message d’erreur provenant de `ErrorMessage` de IRuleContext. Il affiche également des liens vers les champs de la collection. Définir cette propriété sur `false` exclut le champ de la liste des liens associés à l’erreur.
IsExportable	bool	Lecture seule	Indique si le champ est destiné à l’exportation (conformément aux paramètres de la définition de document).
IsIndexed	bool	Lecture seule	Indique si le champ peut être indexé. Si tel est le cas, la valeur du champ est disponible dans les champs externes du document et de la page de la définition de document.
IsMatched	bool	Lecture seule	Indique si le champ est associé.
IsSuspicious	bool	Lecture seule	Indique si la valeur du champ a été reconnue avec certitude.
IsValid	bool	Lecture seule	Indique si le champ ne contient aucune erreur de format.
IsVerified	bool	Lecture/écriture	Indique si le champ est vérifié. Cette propriété ne fonctionne pas pour les groupes de champs. Elle peut être définie sur `true` dans les règles, même sans autorisation d’écriture sur le champ. Pour désactiver l’indicateur, une autorisation d’écriture est requise. Si l’indicateur a la valeur `true`, le champ s’affiche en gris dans l’éditeur de documents, comme s’il était déjà confirmé. Si l’indicateur a la valeur `false`, le champ s’affiche en blanc et doit être confirmé. Après vérification du champ, l’indicateur est défini sur `true`. Définir cet indicateur sur `false` n’achemine pas le champ vers l’étape Data Verification. Pour ce faire, utilisez la propriété `NeedVerification` des interfaces `IField` ou ICharacterParams.
IsVisible	bool	Lecture/écriture	Indique si le champ doit apparaître dans la structure du document (conformément aux paramètres de la définition de document).
Éléments	IFields	Lecture seule	Instances du champ (lignes des champs de tableau).
Nom	string	Lecture seule	Le libellé du champ dans la définition de document.
NeedVerification	bool	Lecture/écriture	Indique si le champ lui-même (et non ses caractères) doit être vérifié. Si l’indicateur est défini sur `true`, le champ s’affiche sur fond rouge dans l’éditeur de documents, ce qui indique qu’il doit être vérifié. Si l’option envoyer en vérification de champ est sélectionnée dans les propriétés du champ, le champ est acheminé vers l’étape Data Verification. Après vérification du champ, l’indicateur est défini sur `false`. Pour indiquer si certains caractères, et non l’ensemble du champ, doivent être vérifiés, utilisez la propriété `NeedVerification` de l’interface ICharacterParams.
ReadOnly	bool	Lecture seule	Indique si le champ est en lecture seule (conformément aux paramètres de la définition de document). Lorsqu’elle est utilisée dans des règles, indique que la règle dispose d’une autorisation d’écriture sur le champ.
ReadOnlyInForm	bool	Lecture/écriture	Indique si le champ du formulaire est en lecture seule (conformément aux paramètres de la définition de document).
Régions	IFieldRegions	Lecture seule	Un tableau de régions de champ. Les champs débordants peuvent comporter plusieurs régions. Disponible uniquement si l’option Advanced XML Export est sélectionnée dans les propriétés de la licence.
Lignes	IFields	Lecture seule	Un ensemble de lignes de tableau. Non disponible pour les champs qui ne sont pas des tableaux.
Symboles	ICharactersParams	Lecture seule	Informations détaillées sur les propriétés des symboles.
Text	string	Lecture/écriture	Représentation textuelle de la valeur d’un champ.
Type	TExportFieldType	Lecture seule	Le type d’un champ.
Value	VARIANT	Lecture/écriture	Valeur du champ au format VARIANT. La propriété renvoie un objet `Int32` lorsque les paramètres du champ indiquent qu’il contient un entier dont la valeur absolue ne dépasse pas `2147483647`. Si la valeur absolue du champ dépasse `2147483647`, la propriété renvoie un objet de type double.

Copier une région de champ

Le code suivant copie la région du champ 1 vers le champ 2 :

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

Vérifier les langues dans un champ

Le script utilisateur suivant vérifie quelles langues sont présentes dans un champ :

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