Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter NineDialog Functions (continued)

ControlSetFocus Function

Overview

The ControlSetFocus function sets keyboard focus onto a specific control.

Syntax/Parameters

Syntax

int = ControlSetFocus ( int id );

Parameters

id

An int that identifies the dialog control that will receive focus.

Return Value

Returns an int value as ERROR_NONE on success, ERROR_RANGE if id is an invalid control ID for the open dialog, or ERROR_INVALID_HANDLE if no dialog is open.

Remarks

Giving a control focus forces the user’s next action to alter that control. Setting focus does not necessarily change the selection or data within a control. Focus can also be set by using the return value during validation.

For basic dialogs, if focus is set during the dialog load procedure, the function will only have effect if the load procedure returns FALSE (ERROR_NONE). For property sheet or paged dialogs, the function is inert during the load procedure since Windows will set the focus to the first control as the page is displayed.

This function can only be used within a dialog procedure.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic