#ctx.collectionField

L'instance CollectionField associée au contexte d'exécution RunJS actuel, utilisée pour accéder aux métadonnées du champ, à son type, aux règles de validation et aux informations d'association. Elle n'existe que lorsque le champ est lié à une définition de collection ; les champs personnalisés ou virtuels peuvent être null.

#Cas d'utilisation

Note : ctx.collectionField est uniquement disponible lorsque le champ est lié à une définition de collection. Il est généralement undefined dans des scénarios tels que les blocs indépendants JSBlock ou les événements d'action sans liaison de champ. Il est recommandé de vérifier la présence de valeurs nulles avant utilisation.

#Définition du type

collectionField: CollectionField | null | undefined;

#Propriétés courantes

#Méthodes courantes

#Exemples

#Rendu conditionnel basé sur le type de champ

if (!ctx.collectionField) return null;
const { interface: iface } = ctx.collectionField;
if (['m2o', 'o2m', 'm2m'].includes(iface)) {
  // Champ d'association : afficher les enregistrements associés
  const target = ctx.collectionField.targetCollection;
  // ...
} else if (iface === 'select' || iface === 'radioGroup') {
  const options = ctx.collectionField.enum || [];
  // ...
}

#Déterminer s'il s'agit d'un champ d'association et accéder à la collection cible

if (ctx.collectionField?.isAssociationField()) {
  const targetCol = ctx.collectionField.targetCollection;
  const titleField = targetCol?.titleCollectionField?.name;
  // Traiter selon la structure de la collection cible
}

#Récupérer les options d'énumération

const options = ctx.collectionField?.enum ?? [];
const labels = options.map((o) => (typeof o === 'object' ? o.label : o));

#Rendu conditionnel basé sur le mode lecture seule / affichage

const { Input } = ctx.libs.antd;
if (ctx.collectionField?.readonly) {
  ctx.render(<span>{ctx.getValue?.() ?? '-'}</span>);
} else {
  ctx.render(<Input onChange={(e) => ctx.setValue?.(e.target.value)} />);
}

#Obtenir le champ de titre de la collection cible

// Lors de l'affichage d'un champ d'association, utilisez targetCollectionTitleField pour obtenir le nom du champ de titre
const titleField = ctx.collectionField?.targetCollectionTitleField;
const titleKey = titleField?.name ?? 'title';
const assocValue = ctx.getValue?.() ?? ctx.record?.[ctx.collectionField?.name];
const label = assocValue?.[titleKey];

#Relation avec ctx.collection

ctx.collection représente généralement la collection liée au bloc actuel ; ctx.collectionField représente la définition du champ actuel dans la collection. Dans des scénarios comme les sous-tableaux ou les champs d'association, les deux peuvent différer.

#Remarques

• Dans des scénarios tels que JSBlock ou JSAction (sans liaison de champ), ctx.collectionField est généralement undefined. Il est recommandé d'utiliser le chaînage optionnel avant d'y accéder.
• Si un champ JS personnalisé n'est pas lié à un champ de collection, ctx.collectionField peut être null.
• targetCollection existe uniquement pour les champs de type association (ex: m2o, o2m, m2m) ; enum existe uniquement pour les champs avec des options comme select ou radioGroup.

#Voir aussi

• ctx.collection : Collection associée au contexte actuel
• ctx.model : Modèle où se trouve le contexte d'exécution actuel
• ctx.blockModel : Bloc parent portant le JS actuel
• ctx.getValue(), ctx.setValue() : Lire et écrire la valeur du champ actuel