Keyboard-related properties of the HostOptions object

Applies To Objects

Description

The properties in this group let you modify the keystrokes that are sent to the screen or the host when a key or combination of keys is pressed. They are equivalent to the options on the page Settings, Display, Keyboard.

Syntax

Unless noted, all keyboard-related properties have the following syntax:

object.Property

Element	Description
Object	The HostOptions object.
Property	A keyboard-related property.

Names and Descriptions of individual properties

BackspaceDoesDelete Property

Returns or sets whether the BACKSPACE key sends the DEL or BS character when pressed. If TRUE, it sends a DEL character. If FALSE, it sends a BS character.

CursorKeyModeApplication Property

Returns or sets whether the cursor keys send ANSI cursor control sequences or control functions when pressed. If TRUE, keys send control functions. If FALSE, keys send ANSI cursor control sequences.

FnKey Property

These five properties (F1Key, F2Key,) return or set the actions to take when an F key is pressed.

Use a constant or value from the following table to determine the action taken for a particular F key.

Constant	Value	Action when pressed
xFKEYLOCALACTION	0	Perform the Local Action listed in the next table.
xFKEYFKEY	1	Send the appropriate Function Key sequence.
xFKEYIGNORE	2	Key does nothing.

Property	Local Action
F1Key	Stop text scrolling.
F2Key	Perform VT print functions.
F3Key	Perform the Compose function.
F4Key	Send the Escape code.
F5Key	Send a break signal.

KeypadModeApplication Property

Returns or sets whether the keypad keys send number or control sequences when pressed. If FALSE, a keypad key sends the ASCII code of the number shown on the keycap. If TRUE, it sends control sequences.

MarginBell Property

Returns or sets a condition for which the bell sounds. If TRUE, the bell sounds when the text cursor approaches the right margin.

WarningBell Property

Returns or sets a condition for which the bell sounds. If TRUE, the bell sounds for operating errors or when the terminal receives ASCII BEL.