clickCharChunk

returns the position of the character the user last clicked in a field.

# Metadata

Platforms: desktop, mobile OS: mac, windows, linux, ios, android Introduced: 1.0 Security:

# Syntax

the clickCharChunk

# Examples

the clickCharChunk

if word 2 of the clickCharChunk < 100 then put the clickChar into me

# Description

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

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

The charNum is the character the mouse pointer was over when the mouse was clicked. Moving the mouse before the mouse button is released does not affect the value return by the clickCharChunk.

The first and second character numbers in the return value are always identical, unless the click was on a field but there was no text under it. In this case, the clickCharChunk returns a chunk expression of the form char charNumber to charNumber - 1 of field fieldNumber indicating the start of the clickLine. For example, if the mouse is over an empty field, the clickCharChunk returns char 1 to 0 of field fieldNumber.

If the field is locked, the clickCharChunk function is most useful within a handler (such as mouseDown or mouseUp) that is trigger 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 clickCharChunk function within a selectionChanged handler to determine what characters the user is editing in an unlock field.

To get the actual character clicked, use the clickChar function.

# Tags

ui,

# See

- **keyword:** field, character, characters - **message:** mouseDown, mouseUp, selectionChanged - **function:** value, mouseCharChunk, clickText, clickStack, clickChar - **glossary:** return, chunk expression, handler, mouse button, trigger, message, unlock, hypertext, mouse pointer - **control structure:** function