returns the character the mouse pointer is over.
# Metadata
Platforms: desktop, server, mobile OS: mac, windows, linux, ios, android Introduced: 1.0 Security:
# Syntax
the mouseChar
# Examples
the mouseChar
if the mouseChar is a number then goToFootnote
# Description
Use the mouseChar function within a handler to determine which character the mouse is hovering over, in order to take some action based on the current character.
The mouseChar function only returns characters in a field. If the mouse pointer is not over a field, the mouseChar function returns empty.
To find the position of the mouseChar within the field, use the mouseCharChunk function.
# Tags
ui,
# See
- **keyword:** characters, character, field - **function:** mouseLine, clickChar, mouseCharChunk - **glossary:** handler, mouse pointer, return - **control structure:** function