InvalidInputDetect (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Invalid input management functions

InvalidInputDetect

Presentation

Example

Characteristics of the verification/detection of controls that require data input/contain invalid data

Miscellaneous

See also

InvalidInputDetect (Function)

In french: SaisieInvalideDétecte

Detects and signals an error on required controls left empty and/or controls with invalid data.

Example

// Event "Allow closing" of a window
IF InvalidInputDetect() THEN
RESULT False
ELSE
RETURN True
END

Syntax

<Result> = InvalidInputDetect([<Element used>])

<Result>: Boolean

True if at least one required control is left empty or contains invalid data,
False otherwise.

<Element used>: Optional control name or window name

Name of the control or window to be checked. If the control is a container (Tab control, Supercontrol, etc.), all its controls will be checked.
If this parameter is not specified, all the controls in the current window will be checked.

Remarks

Characteristics of the verification/detection of controls that require data input/contain invalid data

The input will be checked in the following types of controls:

Radio Button/Check Box control: if the required input option has been enabled (or the MandatoryInput property is set to True), checks that at least one option is selected.
Rating control: if the required input option has been enabled (or the MandatoryInput property is set to True), checks that a rating has been selected.
Editable Combo Box: if the required input option has been enabled (or the MandatoryInput property is set to True), checks that a value has been entered or selected in the combo box.
If an input mask has been used, the function checks that the entered data matches this mask.
If a custom mask with an InputMask variable is used, the verification is performed by executing the procedure associated with the CheckIfValidInput property of this mask.
Non-editable Combo Box: if the required input option has been enabled (or the MandatoryInput property is set to True), checks that a value has been selected in the combo box.
Edit control: if the required input option has been enabled (or the MandatoryInput property is set to True), checks that a value has been entered or selected in the control.
If an input mask has been used, the function checks that the entered data matches this mask. If a custom mask with an InputMask variable is used, the verification is performed by executing the procedure associated with the CheckIfValidInput property of this mask.

Only active and visible controls are checked.

Miscellaneous

The function sets focus to the first control detected according to the tab order.
You can customize the error display mode in the description window of the relevant controls.
The error status will disappear once the entered data is modified by the user or through programming.
To know which controls are required/contain invalid data without highlighting them, use InvalidInputListControl.
The MandatoryInputMessage and InvalidInputMessage properties are used to customize the error messages displayed in case of invalid/required input.
Special case: Edit control or editable Combo Box control with input mask customized via an InputMask variable. If the control does not have focus when InvalidInputDetect is called, the text displayed in the control will first be formatted with the FormatDuringEntry property of the mask before checking its validity.

Business / UI classification: UI Code

Component: wd270obj.dll