BBjCEdit::getIgnoreEnters

Description

In BBj 5.0 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 1 (TRUE)
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

See Also

BBjAPI

BBjSysGui

BBjControl

BBjWindow

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



______________________________________________________________________________________

Copyright BASIS International Ltd. BBj®, Visual PRO/5®, PRO/5®, and BBx® are registered trademarks.