IField

AddRegion( page : IPage, rect : string ) : IFieldRegion

Ajoute au champ une région avec les coordonnées spécifiées. rect est une description de rectangle au format [left,top,right,bottom]. Cette méthode nécessite des droits d’écriture sur l’objet IField.

Remarque : Cette méthode n’est pas disponible pour les tableaux. Pour supprimer une région, utilisez la méthode IFieldRegion.Delete().

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. Indisponible dans les script rules.

CheckRules( )

Vérifie les règles du champ donné et de ses enfants. Ne peut pas être utilisé dans les règles.

Field( Path : string) : IField

Recherche l’élément enfant par rapport à l’élément donné. Des chemins relatifs sont utilisés. Seuls les synonymes des noms de champ tels qu’ils sont définis dans les paramètres des règles peuvent être utilisés dans les règles.

GetFieldExtractor( )

Retourne un objet IFieldExtractor.

GetLangs() : IVARAIANTArray

Retourne les ID des langues détectées dans un champ.

HasField( parameter : string) : bool

Vérifie si le champ correspondant au chemin spécifié existe. Des chemins relatifs sont utilisés. Seuls les synonymes des noms de champ tels qu’ils sont définis dans les paramètres des règles peuvent être utilisés dans les règles.

Suggest( VARIANT newSuggest )

Ajoute un prompt au champ.

Remarque : Il peut prendre la forme d’une valeur ou d’une chaîne. Les valeurs ajoutées sont écrites avec quatre décimales.

Par exemple, la méthode 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.

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.

Children

IFields

Lecture seule

Éléments enfants du champ (cellules de tableau). Indisponible dans les règles de script.

FullName

string

Lecture seule

Nom complet du champ dans le 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 coïncide avec Name et n’est pas unique.

HasRuleError

bool

Lecture/écriture

Indique si un avertissement ou une erreur de règle est associé au champ.

Remarque : Dans les règles de script, cette propriété indique s’il faut afficher le champ dans le message d’erreur.

Une règle inclut une collection de champs spécifiés dans la propriétés de la règleboîte de dialogue des propriétés de la règle. Si la vérification de la règle échoue, un message d’erreur (spécifié dans IRuleContext .ErrorMessage) ainsi que des liens vers les champs de la collection s’affichent dans l’éditeur de documents. 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 est indexable. Si oui, la valeur du champ peut être accessible à partir des champs externes du document et de la page dans la Document Definition.

IsMatched

bool

Lecture seule

Indique si le champ est associé.

IsSuspicious

bool

Lecture seule

Indique si la valeur du champ est 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é.
Remarque : La propriété ne fonctionne pas pour les groupes de champsgroupes de champs.
La propriété peut être définie sur true dans les règles, même sans autorisations “write” pour le champ. Pour désactiver l’indicateur, des autorisations “write” sont requises.

Si l’indicateur est true, le champ s’affiche en gris dans l’éditeur de documents, comme s’il était déjà confirmé. Si l’indicateur est false, le champ s’affiche en blanc et doit être confirmé. Une fois le champ vérifié, l’indicateur est défini sur true.

Remarque : Définir cet indicateur sur false n’achemine pas le champ vers l’étape de vérification des données. Pour cela, utilisez la propriété NeedVerification de l’interface IField ou de l’interface ICharacterParams.

IsVisible

bool

Lecture/écriture

Indique si le champ doit apparaître dans la mise en page du document (selon les paramètres de la définition de document).

Items

IFields

Lecture seule

Instances du champ (lignes des champs de type tableau).

Nom

string

Lecture seule

Nom du champ dans Document Definition.

NeedVerification

bool

Lecture/écriture

Indique si le champ lui-même (et non ses caractères) nécessite une vérification.

Si l’indicateur vaut true, le champ s’affiche sur un fond rouge dans l’éditeur de documents, ce qui signifie qu’il doit être vérifié. Si l’option Send to field verification est sélectionnée dans les propriétés du champpropriétés du champ, le champ sera acheminé vers l’étape de vérification des données. Une fois le champ vérifié, l’indicateur prend la valeur false.

Pour indiquer si certains caractères, mais pas le champ entier, nécessitent une vérification, utilisez la propriété NeedVerification de l’interface ICharacterParams.

ReadOnly

bool

Lecture seule

Indique si le champ dispose de l’autorisation « lecture seule » (conformément aux paramètres de la définition de document). Dans les règles, indique que la règle dispose de l’autorisation « écriture » pour 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).

Regions**

IFieldRegions

Lecture seule

Un tableau de régions de champ. Les champs débordant sur plusieurs zones peuvent avoir plusieurs régions.

Lignes

IFields

Lecture seule

Ensemble de lignes d’un 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

La représentation textuelle de la valeur d’un champ.

Type

TExportFieldType

Lecture seule

Le type du champ.

Value

VARIANT

Lecture/écriture

La valeur du champ sous forme de VARIANT. La propriété renvoie un objet de type Int32 si les paramètres du champ indiquent qu’il contient un entier et que sa valeur absolue n’est pas supérieure à 2147483647. Si la valeur absolue du champ est supérieure à 2147483647, la propriété renvoie un objet de type double.