SetFocusAndReturnToUserInput (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / Control functions

Focus gain
ScreenFirst, SetFocus and SetFocusAndReturnToUserInput
Error
SetFocusAndReturnToUserInput on the last selected control

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SetFocusAndReturnToUserInput (Function)

In french: DonneFocusEtRetourUtilisateur

Stops the current process, sets the focus to the specified control, window or page, and allows the user to enter data.

SetFocusAndReturnToUserInput can be used in a browser event (onchange, onclick, etc.), but it cannot be used in a local procedure or a global browser procedure.

Remark: This function is equivalent to ReturnToCapture.

Example

// If no value was entered by the user in the control
IF EDT_Edit1 = "" THEN
// Display a message and position the user in edit on the control
Error("Enter a value")
SetFocusAndReturnToUserInput(EDT_Edit1)
END

Syntax

SetFocusAndReturnToUserInput([<Element to handle>])

<Element to handle>: Optional control, window or page name

Name of control, column or window that will gain focus (see Notes). If this parameter is not specified, the current control gains focus.
To specify a control that belongs to a window other than the current window, <Element to handle> must be in the following format: <Window name>.<Control name>.
Name of the control or page that will gain focus (see Notes). If this parameter is not specified, the last current control gains focus.

Remarks

Focus gain

Taking "focus" is represented in different ways:

Blinking cursor (or "Caret") for the edit controls.
Dotted rectangle for the other types of controls (Button, List Box, Radio Button controls, etc.).

ScreenFirst, SetFocus and SetFocusAndReturnToUserInput

These functions have a different behavior:

SetFocusAndReturnToUserInput stops the current process to force the input in the specified control.
ScreenFirst defines which control will receive input focus (when the current code stops and input focus is set back to a control).
SetFocus stops the current process, defines which control will receive input focus and resumes the current process.

Error

A WLanguage error occurs if <Element to handle> does not correspond to a control in the current window or page.

SetFocusAndReturnToUserInput on the last selected control

SetFocusAndReturnToUserInput used without parameters sets the focus on the current control. This function, called in the exit code of an Edit control, is used to force the input in the selected control if the data entered and the expected data do not match.

The control must be one of the following types of controls:

Edit control.
Check Box control.
Radio Button control.
List Box control.
Combo Box control.
"Clickable area" Image control.

If the name of the control corresponds to a string that is built, the alias of the control must be used ("ControlAlias"+Num for example). In this case, no check is performed: JavaScript errors may occur if focus is given to a control that does not exist.

Reminder: The alias of a control corresponds to the name of this control in the HTML page. To find out this alias:

in the code editor, press Shift + F1.
through programming, use the Alias property.

Business / UI classification: UI Code

Component: wd290obj.dll