IField
Effet produit
Un champ de document. Le type de champ peut être déterminé à partir du Type de propriété. Pour les champs de tableaux, les méthodes des objets Rows et Cell sont disponibles.
Méthodes
| Définition | Description |
|---|---|
| AddRegion( page : IPage, rect : chaîne ) : IFieldRegion |
Ajoute une région avec les coordonnées indiquées pour le champ. rect est une description d'un rectangle formaté comme [left,top,right,bottom]. Cette méthode requiert des droits en écriture pour l'objet IField. Exemple de code
|
| Cell( columnName : chaîne, rowNum : entier ) : IField | Récupère une cellule du tableau via le nom de la colonne et le nombre de lignes. Uniquement disponible pour les tableaux. Non disponible dans les règles de scripts. |
| CheckRules( ) | Vérifie les règles pour le champ spécifié et ses champs enfants. Impossible à utiliser dans les règles. . |
| Field( Path : chaîne) : IField | Recherche l'élément enfant en fonction de l'élément spécifié. Les Chemins d'accès relatifs sont utilisés. Seuls les synonymes des noms de champs, tels qu'ils sont définis dans les paramètres des règles, peuvent être utilisés dans les règles. |
| GetFieldExtractor( ) | Renvoie un objet IFieldExtractor. |
| GetLangs() : IVARAIANTArray |
Renvoie les ID des langues détectées dans un champ. Example |
| HasField( parameter : chaîne) : booléen | Vérifie si un champ existe pour le chemin d'accès spécifié. Les Chemins d'accès relatifs sont utilisés. Seuls les synonymes des noms de champs, 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 une invite au champ.
Par exemple, la méthode field.Suggest( "12,90") ajoute l'invite sous la forme « 12,90 », alors que field.Suggest( 12,90 ) ajoute l'invite sous la forme de 12,9000. |
Remarque : Cette méthode n'est pas disponible pour les tableaux. Pour supprimer une région, utilisez la méthode Propriétés
| Nom | Type | Accès | Description |
|---|---|---|---|
| Caption | chaîne | Lecture seule | Le nom du champ affiché sur le formulaire. La valeur de cette propriété peut être identique à la propriété Name. |
| Children | IFields | Lecture seule | Les éléments Enfants du champ (cellules des tableaux). Non disponible dans les règles de scripts. |
| FullName | chaîne | Lecture seule | Un nom de champ complet en rapport avec le document. Un identificateur unique du champ dans le document. Peut être utilisé pour rechercher les champs de document via la méthode Field. Dans les règles de scripts, la valeur retournée coïncide avec Name et n'est pas unique. |
| HasRuleError | booléen | Lecture/écriture |
Spécifie si un avertissement de règle ou une erreur de règle est associée au champ.
Une règle comprend un ensemble 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, un message d'erreur (spécifié dans IRuleContext.ErrorMessage) ainsi que des liens vers les champs de l'ensemble s'affichent dans l'éditeur de documents. En réglant cette propriété sur false, le champ est exclu de la liste des liens associés à l'erreur. |
| IsExportable | booléen | Lecture seule | Indique si le champ est destiné à l'exportation (conformément aux paramètres de la définition de document). |
| IsIndexed | booléen | Lecture seule | Indique si le champ est indexable. Si tel est le cas, il est possible que la valeur du champ soit accessible depuis des champs externes des documents et des pages de la définition de document. |
| IsMatched | booléen | Lecture seule | Indique si le champ est associé. |
| IsSuspicious | booléen | Lecture seule | Indique si la valeur du champ est reconnue avec certitude. |
| IsValid | booléen | Lecture seule | Spécifie si le champ ne contient aucune erreur de format. |
| IsVerified | booléen | Lecture/écriture |
Indique si le champ est vérifié. Si l'indicateur est réglé sur true, le champ s'affiche en gris dans l'éditeur de documents, comme s'il avait déjà été confirmé. Si l'indicateur est réglé sur false, le champ s'affiche en blanc et doit être confirmé. Une fois le champ vérifié, l'indicateur se règle sur true.
|
| IsVisible | booléen | Lecture/écriture | Indique si le champ doit correspondre à la présentation du document (conformément aux paramètres de la définition de document). |
| Items | IFields | Lecture seule | Instances du champ (lignes des champs du tableau). |
| Name | chaîne | Lecture seule | Le nom du champ de la définition de document. |
| NeedVerification | booléen | Lecture/écriture |
Indique si le champ en lui-même (pas ses caractères) doit être vérifié. Si l'indicateur est réglé sur 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 Envoyer vers la vérification de champ est sélectionnée dans les proprié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 se règle sur false. Pour indiquer que certains caractères en particulier, et non le champ entier, doivent être vérifiés, utilisez la propriété NeedVerification de l'interface ICharacterParams interface. |
| ReadOnly | booléen | Lecture seule | Indique si le champ est accessible en "Lecture seule" (conformément aux paramètres de la définition de document). Lorsque ces droits sont utilisés dans les règles, ce paramètre indique que la règle implique un droit en "écriture" pour le champ. |
| ReadOnlyInForm | booléen | Lecture/écriture | Indique si le champ du formulaire dispose des droits « Lecture seule » (conformément aux paramètres de la définition de document). |
| Regions* | IFieldRegions | Lecture seule | Un tableau de régions de champs. Les champs s'étendant sur deux pages peuvent comporter plusieurs régions. |
| Rows | IFields | Lecture seule | Un ensemble de lignes de tableau. Non disponible pour les champs ne faisant pas partie d'un tableau. |
| Symbols | ICharactersParams | Lecture seule | Informations concernant les propriétés des symboles. |
| Text | chaîne | Lecture/écriture | La représentation textuelle d'une valeur de champ. |
| Type | TExportFieldType | Lecture seule | Le type d'un champ. |
| Value | VARIANT | Lecture/écriture | La valeur du champ dans le formulaire de VARIANT. La propriété retourne un objet de type Int32, si les paramètres du champ déclarent 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é retourne un objet de type double. |
* - La propriété n'est pas disponible si l'option Exportation XML avancée des propriétés de licence est désélectionnée.
12.04.2024 18:16:03