Set Edit Properties - GRID SENDMSG() Function 101

Syntax

TF$=SENDMSG(sysgui,id,101,0,mode,edit_params${,context{,ERR=lineref}})

Description

This function sets the values for the cell but does not initialize editing operations. Editing begins automatically when a user double clicks a cell.

Parameter

Description

sysgui

SYSGUI channel.

id

Grid control ID.

101

Number of this SENDMSG() function.

0

Always zero.

mode

Input mode (Visual PRO/5 Rev. 2.22 and 3.01 and later only)

0 - Use INPUTN mode if the mask (or default mask, as set by Set Edit Mask - GRID SENDMSG() Function 79 if the mask is not specified) contains the pound (#) character. Otherwise, use INPUTE mode.

1 - Always use INPUTE mode.

2 - Always use INPUTN mode.

edit_params$

Templated string with parameters that control how the function operates.

The return value is a one-byte string that indicates the success or failure of an operation; $01$ indicates success, $00$ indicates failure.

The structure of edit_params$ is flexible.

Note that when a grid control is in edit cell mode, keystrokes such as arrow keys, function keys, and Enter are not processed by the grid. If the application is to respond to these keys, they must be trapped. This is accomplished by checking for the EDITKEY Notify event (Notify code 6).

The complete string may be defined with this template:

mask:c(1*=0),restore:c(1*=0),initstr:c(1*=0),key:u(2),col:u(2),row:u:(4)

(In Visual PRO/5 Rev. 2.22 and 3.01 and later only, the following is the complete template:)

mask:c(1*=0),restore:c(1*=0),initstr:c(1*=0),key:u(2),col:u(2),row:u:(4),irules:c(1)

Either of these three shorter templates may also be used:

initstr:c(1*=0),key:u(2),col:u(2),row:u(4)
mask:c(1*=0),restore:c(1*=0),key:u(2),col:u(2),row:u(4)
mask:c(1*=0),restore:c(1*=0),initstr:c(1*=0),key:u(2),col:u(2),row:u:(4)