formcycle 8.3.6 - JavaScript for forms
    Preparing search index...

    Interface XmValidatorCallbacks

    Mapping between the possible events the form validator supports, and the signature of the event listener. See also XmValidator.on.

    interface XmValidatorCallbacks {
        begin: (
            beginData: XmValidatorOnBeginData,
        ) => void | XmValidatorOnBeginResult;
        finish: (
            finishData: XmValidatorOnFinishData,
        ) => void | XmValidatorOnFinishResult;
        progress: (
            progressData: XmValidatorOnProgressData,
        ) => void | XmValidatorOnProgressResult;
        requestBegin: (
            requestData: XmValidatorOnRequestBeginData,
        ) => void | XmValidatorOnRequestBeginResult;
        requestFinish: (
            requestData: XmValidatorOnRequestFinishData,
        ) => void | XmValidatorOnRequestFinishResult;
    }
    Index

    Properties

    begin: (beginData: XmValidatorOnBeginData) => void | XmValidatorOnBeginResult

    When a validation process starts. The entire form might be validated, or only a subset of elements.

    This event happens after requestBegin, after the element state update, e.g. after conditions such as hidden-if or read-only-if were evaluated.

    Each begin ends with a finish.

    Type declaration

    finish: (
        finishData: XmValidatorOnFinishData,
    ) => void | XmValidatorOnFinishResult

    When form validation finishes.

    This event happens before requestFinish.

    Each begin ends with a finish.

    Type declaration

    progress: (
        progressData: XmValidatorOnProgressData,
    ) => void | XmValidatorOnProgressResult

    When progress is made during form validation, i.e. every time a single form field was validated. Form validation consists of validation a set of form elements, possibly the entire form.

    This event happens between begin and finish.

    Type declaration

    requestBegin: (
        requestData: XmValidatorOnRequestBeginData,
    ) => void | XmValidatorOnRequestBeginResult

    When a validation was requested, usually via $.fn.validate.

    This event happens before begin, before the element state update, e.g. before conditions such as hidden-if or read-only-if were evaluated.

    Each requestBegin ends with a requestFinish.

    requestFinish: (
        requestData: XmValidatorOnRequestFinishData,
    ) => void | XmValidatorOnRequestFinishResult

    When a requested validation was finished.

    This event happens after finish.

    Each requestBegin ends with a requestFinish.