READINSERT()

From Recital Documentation Wiki
Jump to: navigation, search

Purpose

Function to toggle insert mode on or off during a READ


Syntax

READINSERT([<expL>])


See Also

INSMODE(), Function Keys, KEYBOARD, READEXIT(), REPLAY, SET PCKEYS, SET READINSERT


Description

The READINSERT() function is used to toggle insert mode on or off prior to activating a form. Insert mode is enabled if the result of the logical expression <expL> is .T. and disabled if the result is .F.. The default for READINSERT() is .F., in which case the user must press the [INSERT] key to toggle insert mode on. When READINSERT() is .T., insert mode is automatically on for activated forms. The READINSERT() function will return .T. if READINSERT was ON and .F. if READINSERT was OFF. The command PCKEYS must be set ON when using the function.


Example

? readinsert()
.F.
// Toggle insert mode on
readinsert(.T.)
? readinsert()
.T.


Products

Recital