returns a chunk expression describing the location of the word or grouped text under the mouse pointer.
# Metadata
Platforms: desktop, server, mobile OS: mac, windows, linux, ios, android Introduced: 1.0 Security:
# Syntax
the mouseChunk
# Examples
the mouseChunk
if the shiftKey is down then select the mouseChunk
# Description
Use the mouseChunk function within a handler to determine which word or grouped text the mouse is hovering over, in order to take some action based on the current character.
The mouseChunk function only returns locations in a field. If the mouse pointer is not over a field, the mouseChunk function returns empty.
The return value reports the word the mouse is over. The startChar is the first character of the word, and the endChar is the last character. If the textStyle of the text is "link", the return value specifies the entire grouped text.
To get the text of the word or text group, use the mouseText function.
>*Important:* Words are defined a little differently by the > mouseChunk function than the way they are used in > chunk expressions. A word, for purposes of the > mouseChunk, is any text delimited by spaces, tabs, returns, or > punctuation. If the mouse pointer is over a punctuation character, > only that character is returned.
# Tags
ui,
# See
- **keyword:** word, character, field - **property:** textStyle - **function:** dropChunk, selectedChunk, mouseCharChunk - **glossary:** handler, grouped text, mouse pointer, return, chunk expression, return value - **control structure:** function