Livecode Wiki
Advertisement

Returns the word or text group the user last clicked.

Built-in Function handler[]

Syntax:

clickText()

Examples:

the clickText
if the clickText contains "*" then goToFootnote (the clickText)

Use the clickText function within a mouseDown, mouseUp, or selectionChanged handler to determine which word or [[grouped text|text group]] the user clicked, in order to provide hypertext (clickable text) or take some action based on the click.

The clickText function is cleared at the next mouse click, as well as after some editing actions such as deleting text. If the user has clicked anywhere since clicking the field, the clickText function returns empty.

The returned value contains the word the user clicked. If the textStyle of the clicked text is "link", the returned value contains the entire text group.

Words are defined a little differently by the clickText

function than the way they are used in chunk expressions. A word, for purposes of the clickText, is any text delimited by spaces, tabs, returns, or punctuation. If you click a punctuation character, only that character is returned. This means that, for example, clicking a hyphenated word only returns the part of the word that was clicked.

The returned value indicates the text 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 clickText.

If the field is locked, the clickText 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 clickText function within a selectionChanged handler to determine what text the user is editing in an unlocked field.

To get the location of the word or text group clicked, use the clickChunk function.

See also: clickCharChunk (function),selectedText (function),clickChunk (function),clickChar (function),foundText (function),mouseDown (message),mouseUp (message),selectionChanged (message),

Advertisement