Objeto de ámbito en funciones personalizadas
En Forms adaptable, se pasa un objeto de ámbito como el último argumento a las funciones cuando se ejecuta una regla. Se puede utilizar para leer las propiedades del formulario/campo y modificar el formulario desde las funciones. El objeto de ámbito contiene un objeto proxy de solo lectura para el formulario, el evento activado y el campo de destino. Se puede tener acceso a las propiedades de formulario y campo mediante el objeto de ámbito adjuntando $, por ejemplo, scope.form.$id y scope.field.$id, respectivamente.
Funciones de modificación de formularios que utilizan un objeto de ámbito
El objeto de ámbito tiene las siguientes funciones para la modificación del formulario:
Función
Sintaxis
Descripción
Muestra de código
setProperty
setProperty(any $element, any $payload)Establece una propiedad en el campo de destino mediante
$payload.Haga clic aquí para ver el ejemplo.
validar
validate([any $element])Ejecuta la validación en el campo de destino. Ejecuta la validación en todo el formulario si no se proporciona ningún destino y devuelve una matriz de errores de validación.
Haga clic aquí para ver el ejemplo.
restablecer (obsoleto)
reset([any $element])Obsoleto. Utilice
dispatchEvent($target, 'reset') en su lugar. Restablece el campo de destino o, si no se proporciona ningún destino, restablece todo el formulario.Haga clic aquí para ver el ejemplo.
importData
importData(any $payload)Importa datos al formulario y reemplaza los datos de formulario existentes. Si se especifica
qualifiedName, los datos solo se importan en ese campo contenedor.Haga clic aquí para ver el ejemplo.
submitForm
submitForm(any $data [, boolean $validate_form = true, string $submit_as = 'multipart/form-data'])Déclencheur el envío de un formulario. Puede especificar lo que desea enviar mediante el parámetro
$payload y establecer el tipo de contenido mediante el parámetro $contentType. Los datos se envían como multipart/form-data de manera predeterminada. El parámetro opcional $validateForm especifica si el formulario debe validarse antes del envío (valor predeterminado: true). Una vez realizado correctamente, se activa submitSuccess; si se produce un error, se activa submitError.Haga clic aquí para ver el ejemplo.
setFocus
setFocus(any $element [, FocusOption $focusOption])Establece el enfoque en el campo de destino, que puede ser un panel o un campo de formulario. Si no se proporciona ningún objetivo, el enfoque se establece en el campo que activó la regla. El parámetro opcional
$focusOption especifica si el elemento siguiente o anterior relativo al destino debe estar enfocado. Valores compatibles: 'nextItem', 'previousItem'. Si se utiliza con un panel, la navegación se restringe a ese panel. Si se utiliza con un campo, la navegación se produce dentro del panel principal de ese campo.Haga clic aquí para ver el ejemplo.
EventoEnvío
dispatchEvent(any $element, string $eventName [, any $payload])Envía un evento de tipo
$eventName en el elemento determinado por $target. Si no se proporciona ningún destino, el evento se enviará en el formulario. El elemento opcional $payload está disponible para las expresiones que administran el evento. El parámetro $dispatch opcional controla el comportamiento de propagación de eventos.Haga clic aquí para ver el ejemplo.
markFieldAsInvalid
markFieldAsInvalid(string $fieldIdentifier, string $validationMessage [, any $option = {useId: true}])Marca el campo identificado por
$fieldIdentifier como no válido y muestra $validationMessage. El parámetro opcional $option especifica si $fieldIdentifier se interpreta como id, dataRef o qualifiedName. El valor predeterminado es {useId: true}. Valores compatibles: {useId: true}, {useDataRef: true}, {useQualifiedName: true}.Haga clic aquí para ver el ejemplo.
Véase también
- Introducción al Editor de reglas para formularios adaptables basados en componentes principales
- Tipos de operadores y eventos en el editor de reglas de un formulario adaptable basado en componentes principales
- Interfaz de usuario del Editor de reglas para formularios adaptables basados en componentes principales
- Diferentes casos de uso del Editor de reglas para un formulario adaptable basado en componentes principales
- Diferencia en varias ediciones del editor de reglas
- Usar funciones asincrónicas en un formulario adaptable
- Invocar mejoras de servicio en el editor de reglas visuales para formularios basados en componentes principales
- Introducción a las funciones personalizadas para formularios adaptables basados en componentes principales
- Crear una función personalizada para un formulario adaptable basado en componentes principales
- Objeto de ámbito en funciones personalizadas
- Ejemplos de desarrollo y uso de funciones personalizadas
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab