IsFormValid
Zastosowanie
Funkcja sprawdza czy na formularzu:
-
- pola wymagane są uzupełnione
- pola oznaczone przez funkcję FieldIsIncorrect jako nieprawidłowe, mają już prawidłowe wartości
- zostały dodane dokumenty, których wymagalność zależy od ustawień dla szablonów.
Funkcja została zaprojektowana aby była używana w treści reguły ręcznej.
Nie powinna być używana:
- w warunku reguły (ręcznej, automatycznej czy okresowej)
- w regułach automatycznych bo mogłoby to prowadzić do zapętlenia reguł. Obecnie wynik działania IsFormValid w regule automatycznej może być nieprzewidywalny i nie należy na nim polegać.
Składnia
IsFormValid();
IsFormValid(loginfo);
Argumenty
- loginfo – (Boolean) [Opcjonalnie] Jeżeli podane jest true, wtedy system zapisze do logów informację, które elementy powodują, że funkcja zwraca wartość false.
Return value
Funkcja zwraca wartość logiczną.
Zwraca true jeżeli na bieżącym formularzu pola wymagane są wypełnione oraz nie występują pola, które oznaczono FieldIsIncorrect, w przeciwnym wypadku zwraca, false
Przykłady
Przykład 1:
valid = IsFormValid();
Sprawdza, czy pola wymagane są wypełnione, a wynik zapisuje do zmiennej o nazwie valid
Przykład 2:
Użycie funkcji w warunku if() pozwala na wykonanie dalszych funkcji tylko, gdy wszystkie pola są prawidłowo wypełnione.
if(IsFormValid() == true) { ChangeStage("NextStage"); }