BBjInputN::getInsertMode

Description

Returns whether the BBjInputN control is in insert mode.

Syntax

Return Value

Method

boolean

getInsertMode()

Parameters

None.

Return Value

Returns whether the BBjInputN control is in the insert mode (0 = Not in insert mode, 1 = In insert mode).

Remarks

By default, the BBjInputN control is in insert mode.

Example

rem 'Determine if an InputN control is in insert mode

rem 'Obtain the instance of the BBjAPI object
let myAPI! = BBjAPI()

rem 'Open the SysGui device
SYSGUI = UNT
OPEN (SYSGUI) "X0"

rem 'Obtain the instance of the BBjSysGui object
let mySysGui! = myAPI!.getSysGui()

rem 'Set addWindow param values
X = 10
Y = 10
WIDTH = 200
HEIGHT = 200
TITLE$ = "BBj Window"

rem 'Set the current context
mySysGui!.setContext(0)

rem 'Create a window
myWindow! = mySysGui!.addWindow(X,Y,WIDTH,HEIGHT,TITLE$)

rem 'Add an INPUTN control that limits input to 10 characters, and inserting
rem 'the value 1 when the user hits the restore key (normally ESCAPE)
myInputN! = myWindow!.addInputN(101,50,100,90,30,$0804$,"##,###,###.00",$$,1,0)

rem 'Set an InputN control to be in insert mode
myInputN!.setInsertMode(mySysGui!.TRUE)

rem 'Determine if an InputN control is in insert mode, this will return true (1)
INSERT_MODE = myInputN!.getInsertMode()

rem 'Register the CALLBACK routines
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())

rem 'Process Events
process_events

rem 'Callback routine called when the user closes the application window
APP_CLOSE:
release

See Also

BBjAPI

BBjSysGui

BBjControl

BBjWindow

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.