Freigeben über

setActiveStage (Client-API-Referenz)

  • Artikel

Legt eine abgeschlossene Phase als aktive Phase fest.

Syntax

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

Parameter

Name des Dataflows Type Erforderlich Beschreibung
stageId String Ja Die ID der abgeschlossenen Phase für die Tabelle, um als aktive Phase zu gelten.
callbackFunction Function Nein Eine Funktion, die aufgerufen wird, wenn der Vorgang abgeschlossen ist. Siehe callbackFunction-Parameter

callbackFunction-Parameter

Dieser Rückruffunktion wird einer der folgenden Zeichenfolgenwerte übergeben, um den Status eines Vorgangs anzuzeigen:

Wert Ursache
success Der Vorgang war erfolgreich.
invalid Es gibt drei Gründe, weshalb dieser Wert zurückgegeben werden kann:
- Die stageId ist ein nicht-bestehender Phasen-ID-Wert.
- Die aktive Phase ist nicht die ausgewählte Phase.
- Der Datensatz ist noch nicht gespeichert.
unreachable Die Phase befindet sich in einem anderen Pfad.
dirtyForm Dieser Wert wird zurückgegeben, wenn die Daten auf der Seite nicht gespeichert werden.
preventDefault Dieser Wert wird zurückgegeben, wenn ein OnPreStageChange-Ereignishandler „PreventDefault“ aufruft.

Wichtig

Diese Methode kann nur verwendet werden, wenn die ausgewählte Phase und die aktive Phase identisch sind. Wenn Ihr Code vom OnStageChange-Ereignis initiiert wird, wird die aktuelle Phase ausgewählt. Wenn Ihr Code vom OnStageSelected-Ereignis initiiert wird, sollten Sie die getActiveStage-Methode verwenden, um zu überprüfen, ob die ausgewählten Phase auch die aktive Phase ist. Für ein anderes Formularereignis ist es nicht möglich, zu ermitteln, welche Phase derzeit ausgewählt ist. Zur Erzielung optimaler Ergebnisse sollte diese Methode nur in Code verwendet werden, der in Funktionen verwendet wird, die von den OnStageChange und OnStageSelected-Ereignissen initiiert werden.

Ähnliche Artikel

getActiveStage
formContext.data.process

Hinweis

Können Sie uns Ihre Präferenzen für die Dokumentationssprache mitteilen? Nehmen Sie an einer kurzen Umfrage teil. (Beachten Sie, dass diese Umfrage auf Englisch ist.)

Die Umfrage dauert etwa sieben Minuten. Es werden keine personenbezogenen Daten erhoben. (Datenschutzbestimmungen).