#ctx.collection

Die Instanz der Sammlung (Collection), die mit dem aktuellen RunJS-Ausführungskontext verknüpft ist. Sie wird verwendet, um auf Metadaten der Sammlung, Felddefinitionen, Primärschlüssel und andere Konfigurationen zuzugreifen. Sie stammt normalerweise von ctx.blockModel.collection oder ctx.collectionField?.collection.

#Anwendungsfälle

Hinweis: ctx.collection ist in Szenarien verfügbar, in denen ein Daten-Block, Formular-Block oder Tabellen-Block an eine Sammlung gebunden ist. In einem unabhängigen JS-Block, der nicht an eine Sammlung gebunden ist, kann dieser Wert null sein. Es wird empfohlen, vor der Verwendung eine Prüfung auf Nullwerte durchzuführen.

#Typdefinition

collection: Collection | null | undefined;

#Gängige Eigenschaften

#Gängige Methoden

#Beziehung zu ctx.collectionField und ctx.blockModel

In Szenarien wie Untertabellen kann ctx.collection die Ziel-Sammlung der Assoziation sein; in Standardformularen oder Tabellen ist es normalerweise die an den Block gebundene Sammlung.

#Beispiele

#Primärschlüssel abrufen und Popup öffnen

const primaryKey = ctx.collection?.filterTargetKey ?? 'id';
await ctx.openView(popupUid, {
  mode: 'dialog',
  params: {
    filterByTk: ctx.record?.[primaryKey],
    record: ctx.record,
  },
});

#Felder für Validierung oder Verknüpfung durchlaufen

const fields = ctx.collection?.getFields() ?? [];
const requiredFields = fields.filter((f) => f.options?.required);
for (const f of requiredFields) {
  const v = ctx.form?.getFieldValue(f.name);
  if (v == null || v === '') {
    ctx.message.warning(`${f.title} ist ein Pflichtfeld`);
    return;
  }
}

#Assoziationsfelder abrufen

const oneToMany = ctx.collection?.getAssociationFields(['many']) ?? [];
// Wird zum Erstellen von Untertabellen, verknüpften Ressourcen usw. verwendet

#Hinweise

• filterTargetKey ist der Name des Primärschlüsselfeldes der Sammlung. Einige Sammlungen verwenden möglicherweise ein string[] für zusammengesetzte Primärschlüssel. Wenn dies nicht konfiguriert ist, wird üblicherweise 'id' als Rückfalloption verwendet.
• In Szenarien wie Untertabellen oder Assoziationsfeldern kann ctx.collection auf die Ziel-Sammlung der Assoziation verweisen, was sich von ctx.blockModel.collection unterscheidet.
• getFields() führt Felder aus vererbten Sammlungen zusammen; lokale Felder überschreiben vererbte Felder mit demselben Namen.

#Verwandte Themen

• ctx.collectionField: Die Felddefinition der Sammlung für das aktuelle Feld
• ctx.blockModel: Der übergeordnete Block, der das aktuelle JS hostet, einschließlich collection
• ctx.model: Das aktuelle Modell, das collection enthalten kann