BBjCEdit::getLimitToOneParagraph

Description

Returns whether the BBjCEdit control is limited to one paragraph.

Syntax

Return Value

Method

boolean

getLimitToOneParagraph()

Parameters

None.

Return Value

Returns whether the BBjCEdit control is limited to one paragraph (0 = Not limited, 1 = Limited).

Remarks

By default, the BBjCEdit control does not limit its contents to one paragraph.

Example

rem 'Determine if a custom edit box is limited to one paragraph

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 limit to one paragraph
myCEdit!.setLimitToOneParagraph(mySysGui!.TRUE)

rem 'Determine if a custom edit box is limited to one paragraph, this will return true (1)
LIMIT_ONE_PARAGRAPH = myCEdit!.getLimitToOneParagraph()

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.