BBjCEdit::getIgnoreEnters

Description

In BBj 5.00 and higher, this method returns whether the ENTER key is ignored in the BBjCEdit control.

Syntax

Return Value	Method
boolean	getIgnoreEnters()

Parameters

None.

Return Value

Returns whether the ENTER key is ignored in the BBjCEdit control (0 = ENTER key not ignored, 1 = ENTER key ignored).

Remarks

By default, the ENTER key is not ignored.

Example

rem 'Determine if a custom edit box is to ignore the ENTER key

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 a CEDIT control on the window
myCEdit! = myWindow!.addCEdit(101,30,100,140,30,"")

rem 'Add a paragraph at index 0 to the CEdit control
myCEdit!.addParagraph(0,"This is a paragraph")

rem 'Set the CEdit control to ignore the ENTER key
myCEdit!.setIgnoreEnters(mySysGui!.TRUE)

rem 'Determine if the CEdit control is to ignore the ENTER key, this will return true (1)
IGNORE_ENTER = myCEdit!.getIgnoreEnters()

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