Activate a control
nvda_activate_objectActivate a control by its nvda_find_objects ID—press buttons, follow links, or toggle checkboxes—then report NVDA’s speech output, no prior focus needed.
Instructions
Perform a control's default action (press a button, follow a link, toggle a check box), like NVDA's activate command, then report what NVDA said.
The control is found with nvda_find_objects and does not need focus first.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | An id from nvda_find_objects. | |
| record | No | Also record what this action changed: how the accessibility tree around it changed (controls added, removed, renamed or moved, values and states) and the events NVDA handled. NVDA is silent for up to a few seconds while the tree is read. For something the user does, use nvda_trace_events with tree. | |
| settle_ms | No | Stop listening once NVDA has been quiet this long. | |
| timeout_ms | No | Stop listening, or waiting for until_speech, after this long in total. | |
| until_speech | No | Keep listening until NVDA says something containing this text (ignoring case), such as 'sent' or a dialog title, instead of stopping at the first pause. The result says whether it was heard. | |
| record_within | No | Record only inside this control, an id from nvda_find_objects, such as a chat's message list. Implies record. By default the web document or window around the action is recorded. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |