Colonnes dans les applications basées sur des modèles (référence de l’API cliente)

Les colonnes contiennent des données dans le formulaire ou les grilles des applications pilotées par modèle. Utilisez la collection formContext.data.entity.attributes ou la méthode de raccourci formContext.getAttribute pour accéder à un ensemble de colonnes. Pour plus d’informations sur les collections, voir Collections (référence de l’API client).

Pour accéder à une colonne dans la collection, transmettez le nom (chaîne) ou la valeur d’index (nombre) de la colonne en tant qu’argument à la méthode. Par exemple : formContext.getAttribute(arg). Si vous ne spécifiez pas d’argument, la méthode retourne une collection de tous les attributs du formulaire.

Les colonnes sont classées par type. Utilisez la méthode getAttributeType pour déterminer le type de la colonne. Certaines méthodes de colonne sont uniquement disponibles pour des types de colonnes spécifiques.

Cet article fournit des informations sur les méthodes disponibles pour chaque type de colonne.

Tous les types de colonne

La propriété controls fournit une collection de contrôles associés à la colonne.

Les méthodes suivantes sont disponibles pour tous les types de colonnes :

Method	Description
addOnChange	Ajoute une fonction à exécuter lorsque l’événement de OnChange la colonne se produit.
fireOnChange	Déclenche l’événement de OnChange la colonne.
getAttributeType	Retourne le type de colonne.
getFormat	Retourne le format de la colonne.
getIsDirty	Retourne si la colonne a des modifications non enregistrées.
getName	Retourne le nom logique de la colonne.
getParent	Retourne l’objet parent formContext.data.entity .
getRequiredLevel	Retourne si une valeur de colonne est requise ou recommandée.
getSubmitMode	Retourne lorsque les données de la colonne sont envoyées lors de l’enregistrement.
getUserPrivilege	Retourne les privilèges de l’utilisateur pour créer, lire ou mettre à jour la valeur de la colonne.
getValue	Retourne la valeur de données de la colonne.
isValid	Retourne si la valeur de la colonne est valide.
removeOnChange	Supprime une fonction des gestionnaires d’événements de OnChange la colonne.
setIsValid	Définit la validité de la colonne et un message d’erreur.
setRequiredLevel	Définit si une valeur de colonne est requise ou recommandée avant l’enregistrement.
setSubmitMode	Définit si les données de la colonne sont envoyées lors de l’enregistrement.
setValue	Définit la valeur de données de la colonne.

Type de colonne booléenne

Outre les méthodes disponibles pour tous les types de colonnes, le type de colonne booléen fournit la méthode suivante :

Method	Description
getInitialValue	Retourne la valeur de la colonne lors de l’ouverture du formulaire.

Type de colonne de recherche

Outre les méthodes disponibles pour tous les types de colonnes, le type de colonne de recherche fournit la méthode suivante :

Method	Description
getIsPartyList	Retourne si la recherche autorise plusieurs enregistrements en tant que recherche de liste de tiers.

Option et types de colonne d’option

Outre les méthodes disponibles pour tous les types de colonnes, les choix et les types de colonnes de choix fournissent les méthodes suivantes :

Method	Description
getInitialValue	Retourne la valeur de la colonne lors de l’ouverture du formulaire.
getOption	Retourne l’option correspondant à une étiquette ou une valeur spécifiée.
getOptions	Retourne les options valides de la colonne.
getSelectedOption	Retourne l’option ou les options sélectionnées.
getText	Retourne le texte de l’option ou des options sélectionnées.

Type de colonne de nombre (décimal, double, entier, devise)

Les méthodes suivantes sont disponibles uniquement pour les colonnes décimale, double et entier :

Method	Description
getMax	Retourne la valeur maximale autorisée de la colonne.
getMin	Retourne la valeur minimale autorisée de la colonne.
getPrecision	Retourne le nombre de chiffres autorisés après la virgule décimale.
setPrecision	Définit le nombre de chiffres autorisés après la virgule décimale.

Type de colonne de chaîne

Outre les méthodes disponibles pour tous les types de colonnes décrits précédemment, la méthode suivante est disponible uniquement pour la colonne chaîne :

Method	Description
getMaxLength	Retourne la longueur maximale de chaîne de la colonne.

Articles associés

Comprendre le modèle d’objet Xrm
Contrôles (référence de l’API client)