#ctx.collectionField

La instancia del campo de la colección (CollectionField) asociada al contexto de ejecución actual de RunJS, utilizada para acceder a los metadatos, tipos, reglas de validación e información de asociación del campo. Solo existe cuando el campo está vinculado a la definición de una colección; los campos personalizados o virtuales pueden ser null.

#Escenarios de uso

Nota: ctx.collectionField solo está disponible cuando el campo está vinculado a la definición de una colección; suele ser undefined en escenarios como bloques independientes (JSBlock) o eventos de acción sin vinculación a campos. Se recomienda realizar una comprobación de valores nulos antes de su uso.

#Definición de tipo

collectionField: CollectionField | null | undefined;

#Propiedades comunes

#Métodos comunes

#Ejemplos

#Renderizado condicional basado en el tipo de interfaz

if (!ctx.collectionField) return null;
const { interface: iface } = ctx.collectionField;
if (['m2o', 'o2m', 'm2m'].includes(iface)) {
  // Campo de asociación: mostrar registros asociados
  const target = ctx.collectionField.targetCollection;
  // ...
} else if (iface === 'select' || iface === 'radioGroup') {
  const options = ctx.collectionField.enum || [];
  // ...
}

#Determinar si es un campo de asociación y acceder a la colección de destino

if (ctx.collectionField?.isAssociationField()) {
  const targetCol = ctx.collectionField.targetCollection;
  const titleField = targetCol?.titleCollectionField?.name;
  // Procesar según la estructura de la colección de destino
}

#Obtener opciones de enumeración

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

#Renderizado condicional basado en el modo de solo lectura/visualización

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

#Obtener el campo de título de la colección de destino

// Al mostrar un campo de asociación, use targetCollectionTitleField para obtener el nombre del campo de título
const titleField = ctx.collectionField?.targetCollectionTitleField;
const titleKey = titleField?.name ?? 'title';
const assocValue = ctx.getValue?.() ?? ctx.record?.[ctx.collectionField?.name];
const label = assocValue?.[titleKey];

#Relación con ctx.collection

ctx.collection normalmente representa la colección vinculada al bloque actual; ctx.collectionField representa la definición del campo actual dentro de la colección. En escenarios como subtablas o campos de asociación, ambos pueden diferir.

#Notas

• En escenarios como JSBlock o JSAction (sin vinculación a campos), ctx.collectionField suele ser undefined. Se recomienda utilizar el encadenamiento opcional (optional chaining) antes de acceder a él.
• Si un campo JS personalizado no está vinculado a un campo de la colección, ctx.collectionField puede ser null.
• targetCollection solo existe para campos de tipo asociación (ej. m2o, o2m, m2m); enum solo existe para campos con opciones como select o radioGroup.

#Relacionado

• ctx.collection: Colección asociada al contexto actual
• ctx.model: Modelo donde se encuentra el contexto de ejecución actual
• ctx.blockModel: Bloque padre que contiene el JS actual
• ctx.getValue(), ctx.setValue(): Leer y escribir el valor del campo actual