setActiveStage (referencia de la API de cliente)

  • Artículo

Establece una fase completada como fase activa.

Sintaxis

formContext.data.process.setActiveStage(stageId, callbackFunction);

Parámetros

Name Type Obligatorio Description
stageId String Sí El identificador de la fase completada para que la tabla cree la fase activa.
callbackFunction Function No Una función para llamar una vez terminada la operación. Vea el parámetro callbackFunction

Parámetro callbackFunction

A esta función de devolución de llamada se le pasa uno de los siguientes valores de cadena para indicar el estado de la operación:

valor Motivo
success La operación se ha realizado correctamente.
invalid Hay tres razones por las que este valor puede ser devuelto:
- El parámetro stageId es un valor de Id. de fase inexistente.
- La fase activa no es la fase seleccionada.
- El registro aún no se ha guardado.
unreachable La fase existe en otra ruta.
dirtyForm Esta valor se devolverá si los datos en la página no se guardan.
preventDefault Este valor se devolverá si un controlador de evento OnPreStageChange llama a preventDefault.

Importante

Este método se puede usar únicamente cuando la fase seleccionada y la fase activa son iguales. Cuando el código se inicia desde el evento OnStageChange, la fase actual se seleccionará. Cuando se inicia el código desde el evento OnStageSelected, debe usar el método getActiveStage para comprobar que la fase seleccionada también es la fase activa. Para cualquier otro evento de formulario, no es posible determinar qué fase está seleccionada actualmente. Para obtener los mejores resultados, este método se debe usar solo en código al que se llame en funciones iniciadas por los eventos OnStageChange y OnStageSelected.

getActiveStage
formContext.data.process

Nota

¿Puede indicarnos sus preferencias de idioma de documentación? Realice una breve encuesta. (tenga en cuenta que esta encuesta está en inglés)

La encuesta durará unos siete minutos. No se recopilan datos personales (declaración de privacidad).