clickField

Typefunction
DictionaryLCS
LibraryLiveCode Script
Syntax
the clickField
clickField()
Summary

Returns the number of the last field the user clicked.

Introduced1.0
OSmac, windows, linux, ios, android
Platformsdesktop, mobile
Example
the clickField
if the clickField is field "New Items" then exit mouseUp
Values
NameTypeDescription
return

The clickField function returns the number of the clicked field.

RelatedKeyword: field
Message: mouseDown, mouseUp, selectionChanged
Function: clickStack, number
Glossary: handler, message, trigger, return, hypertext
Control Structure: function
Description

Use the clickField function within a mouseDown, mouseUp, or selectionChanged handler to determine which field the user clicked, in order to provide hypertext (clickable text) or take some action based on the click.

The clickField function is cleared at the next mouse click, as well as after some editing actions such as deleting text. If the last click was not in a field, the clickField function returns empty.

The returned value indicates the field that the mouse pointer was over when the mouse was clicked. Moving the mouse before the mouse button is released does not affect the value returned by the clickField.

If the field is locked, the clickField function is most useful within a handler (such as mouseDown or mouseUp) that is triggered by the mouse click.

If the field is unlocked, mouseDown and mouseUp messages are not sent when the user clicks in the field (unless the user right-clicks or holds down the Control key while clicking). Use the clickField function within a selectionChanged handler to determine what field the user is editing.

Tagsui