#ctx.collectionField

Die Instanz des Datentabellenfeldes (CollectionField), die mit dem aktuellen RunJS-Ausführungskontext verknüpft ist. Sie wird verwendet, um auf Metadaten, Typen, Validierungsregeln und Verknüpfungsinformationen des Feldes zuzugreifen. Sie existiert nur, wenn das Feld an eine Definition einer Sammlung gebunden ist; benutzerdefinierte oder virtuelle Felder können null sein.

#Anwendungsbereiche

Hinweis: ctx.collectionField ist nur verfügbar, wenn das Feld an die Definition einer Sammlung (Collection) gebunden ist. In Szenarien wie unabhängigen JSBlock-Blöcken oder Aktionsereignissen ohne Feldanbindung ist es normalerweise undefined. Es wird empfohlen, vor der Verwendung eine Prüfung auf Nullwerte durchzuführen.

#Typdefinition

collectionField: CollectionField | null | undefined;

#Gängige Eigenschaften

#Gängige Methoden

#Beispiele

#Verzweigtes Rendering basierend auf dem Feldtyp

if (!ctx.collectionField) return null;
const { interface: iface } = ctx.collectionField;
if (['m2o', 'o2m', 'm2m'].includes(iface)) {
  // Verknüpfungsfeld: Verknüpfte Datensätze anzeigen
  const target = ctx.collectionField.targetCollection;
  // ...
} else if (iface === 'select' || iface === 'radioGroup') {
  const options = ctx.collectionField.enum || [];
  // ...
}

#Prüfen, ob es ein Verknüpfungsfeld ist, und auf die Ziel-Sammlung zugreifen

if (ctx.collectionField?.isAssociationField()) {
  const targetCol = ctx.collectionField.targetCollection;
  const titleField = targetCol?.titleCollectionField?.name;
  // Verarbeitung gemäß der Struktur der Ziel-Sammlung
}

#Aufzählungsoptionen abrufen

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

#Bedingtes Rendering basierend auf Schreibschutz-/Anzeigemodus

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)} />);
}

#Titelfeld der Ziel-Sammlung abrufen

// Bei der Anzeige eines Verknüpfungsfeldes kann targetCollectionTitleField verwendet werden, um den Namen des Titelfeldes abzurufen
const titleField = ctx.collectionField?.targetCollectionTitleField;
const titleKey = titleField?.name ?? 'title';
const assocValue = ctx.getValue?.() ?? ctx.record?.[ctx.collectionField?.name];
const label = assocValue?.[titleKey];

#Beziehung zu ctx.collection

ctx.collection repräsentiert normalerweise die an den aktuellen Block gebundene Sammlung; ctx.collectionField repräsentiert die Definition des aktuellen Feldes in der Sammlung. In Szenarien wie Untertabellen oder Verknüpfungsfeldern können sich beide unterscheiden.

#Hinweise

• In Szenarien wie JSBlock oder JSAction (ohne Feldanbindung) ist ctx.collectionField normalerweise undefined. Es wird empfohlen, vor dem Zugriff Optional Chaining zu verwenden.
• Wenn ein benutzerdefiniertes JS-Feld nicht an ein Sammlungsfeld gebunden ist, kann ctx.collectionField den Wert null haben.
• targetCollection existiert nur für Felder vom Typ Verknüpfung (z. B. m2o, o2m, m2m); enum existiert nur für Felder mit Optionen wie Select oder RadioGroup.

#Verwandte Themen

• ctx.collection: Mit dem aktuellen Kontext verknüpfte Sammlung
• ctx.model: Modell, in dem sich der aktuelle Ausführungskontext befindet
• ctx.blockModel: Übergeordneter Block, der das aktuelle JS enthält
• ctx.getValue(), ctx.setValue(): Aktuellen Feldwert lesen und schreiben