ReturnToCapture (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Control management functions

ScreenFirst, SetFocus and ReturnToCapture

Error

ReturnToCapture function on a window

ReturnToCapture on a Table control column

ReturnToCapture on the current control

ReturnToCapture on the last selected control

Processes run when using ReturnToCapture

Function ReturnToCapture and FIN:

ReturnToCapture run in the event "Before closing with OK/Close button"

See also

ReturnToCapture (Function)

In french: RepriseSaisie

Stops the current process and forces the input in the specified control, window or page.

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

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

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")
ReturnToCapture(EDT_Edit1)
END

// Position the mouse cursor in a cell of a Table control (multiselection or not)
TABLE_Table_Name = Row_Subscript
ReturnToCapture(TABLE_Table_Name.COL_Column_Name)

Syntax

ReturnToCapture([<Object name>])

<Object name>: Optional character string (with or without quotes)

Name of control, column or window that will take focus (see Notes). If this parameter is not specified, the current control takes focus.
To specify a control that belongs to a window other than the current window, <Object name> must be in the following format: <Window name>.<Control name>.
Name of control or page that will take focus (see Notes). If this parameter is not specified, the last current control takes focus.
Versions 15 and later
Name of control or window that will take focus (see Notes). If this parameter is not specified, the current control takes focus.
New in version 15
Name of control or window that will take focus (see Notes). If this parameter is not specified, the current control takes focus.
Name of control or window that will take focus (see Notes). If this parameter is not specified, the current control takes focus.
Name of control or window that will take focus (see Notes). If this parameter is not specified, the current control takes focus.

Remarks

Focusing

Taking "focus" is represented in different ways:

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

ScreenFirst, SetFocus and ReturnToCapture

These functions have a different behavior:

ReturnToCapture stops the current process to force the input in the specified control.
ScreenFirst describes the next control that will be in edit (when the current code stops and when the input resumes).
SetFocus stops the current process, describes the next control that will be in edit and resumes the current process.

Error

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

ReturnToCapture function on a window

If <Object name> corresponds to a window name, the window is enabled. The control that will take focus in this window will correspond to:

the last control previously in edit in this window,
the first control that can take focus in this window (if no input was previously performed in this window).

ReturnToCapture on a Table control column

The ReturnToCapture function gives the focus to the specified column. If the Table control is not being entered, the Table control goes into entry.

ReturnToCapture on the current control

The ReturnToCapture function used without parameter allows to give focus to the current Control. This function, called in the exit code of edit control, is used to force the input in the selected control if the information typed does not correspond to the expected information.

ReturnToCapture on the last selected control

ReturnToCapture used without parameters sets the focus on the current control. This function, called in the exit code of edit control, is used to force the input in the selected control if the information typed does not correspond to the expected information.

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.
Click Area 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.
by programming, use the Alias property.

Processes run when using ReturnToCapture

The WLanguage code that follows the call to ReturnToCapture is not run and the user takes control.

Special cases:

if the call to ReturnToCapture is performed in a code called by Execute, ExecuteCode or ExecuteProcess, the code called by Execute, ExecuteCode or ExecuteProcess is interrupted. The execution resumes after the call to Execute, ExecuteCode or ExecuteProcess.
if the call to ReturnToCapture is performed in the code of a function of a window other than the current window, the code of this function is interrupted and the execution resumes after its call.
if the call to ReturnToCapture is performed in the code of a component (procedure or method), the code of the component is interrupted and the execution resumes after the call to the procedure or method of the component.
if the call to ReturnToCapture is performed in a code of a procedure of internal window, the code of the procedure of the internal window is interrupted and the execution resumes after the call to the procedure of the internal window.
if the call to ReturnToCapture is performed in the code of a menu option, the code of the menu option is interrupted and the execution resumes after the call to the menu option.
if the call to ReturnToCapture is performed in a window procedure called from a supercontrol, the code of the procedure is interrupted and the execution resumes after the call to the procedure in the supercontrol.
if the call to ReturnToCapture is performed in a procedure of a supercontrol or control template, the code of the procedure is interrupted and the execution resumes after the call to the procedure of the supercontrol or control template.

The current process is permanently interrupted. For example:

ReturnToCapture("Edit1")
Info("XXX") // Is never run

In most cases, the exist events (from the current control or window) and the input events (in the specified control or window) are run at the same time as ReturnToCapture.

Exceptions:

No code is run if <Control name> is the current control.
The exit code of the selected control is not run if ReturnToCapture is used in one of the events of this control.

To avoid interrupting the process, use ScreenFirst or SetFocus.

The WLanguage code that follows the call to ReturnToCapture is not run. The execution of processes resumes:

when the user gets the control back.
during the call to Execute or ExecuteProcess.

Function ReturnToCapture and FIN:

After a call to ReturnToCapture, the code following the "END:" statement is not run. ReturnToCapture can be replaced by the call to ScreenFirst followed by RETURN or RESULT.

ReturnToCapture run in the event "Before closing with OK/Close button"

If ReturnToCapture is called in the event "Before closing with OK/Close button", the current window will not be closed.

Remark: The event "Before closing with OK/Close button" is associated with the "Close" or "OK" button in the window title bar.

Business / UI classification : UI Code

Component : wd260obj.dll