mouseLine

returns a chunk expression describing the location of the line of text under the mouse pointer.

# Metadata

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

# Syntax

the mouseLine

# Examples

the mouseLine

set the backgroundColor of the mouseLine to "yellow"

# Description

Use the mouseLine function within a handler to determine which line the mouse is hovering over, in order to take some action based on the click.

The mouseLine function only returns locations in a field. If the mouse pointer is not over a field, the mouseLine function returns empty.

To get a chunk expression describing the exact word or text group that the mouse is over, use the mouseChunk function.

# Tags

ui,

# See

- **keyword:** field, line - **function:** mouseCharChunk, mouseChar, clickLine, foundLine, selectedLine - **glossary:** handler, mouse pointer, return, chunk expression - **control structure:** function