BBjCEdit::getHorizontalScrollable

Description

Returns whether a horizontal scroll bar will appear when the text is too large to fit within the BBjCEdit control area.

Syntax

Return Value

Method

int

getHorizontalScrollable()

Parameters

None.

Return Value

Returns whether a horizontal scroll bar will appear when the text is too large to fit within the control area (0 = No Horizontal Scroll Bar, 1 = Horizontal Scroll Bar).

Remarks

By default, the BBjCEdit control is not horizontally scrollable.

Example

REM Determine if custom edit box is to be horizontally scrollable

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 Create a BBjVector store paragraphs
myVector! = myAPI!.makeVector()

REM Add paragraphs to the BBjVector
FOR I = 1 TO 4
PARAGRAPH$="This is paragraph " + STR(I)
myVector!.addItem(PARAGRAPH$)
NEXT I

REM Add the paragraphs stored in the vector at index 0 to the CEDIT control
myCEdit!.addParagraphs(0,myVector!)

REM Set a custom edit box to be vertically scrollable
myCEdit!.setHorizontalScrollable(mySysGui!.TRUE)

REM Determine if custom edit box is to be vertically scrollable, this will return 1 (TRUE)
SCROLLABLE = myCEdit!.getHorizontalScrollable()
PRINT "Scrollable ",SCROLLABLE

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
RETURN

See Also

BBjAPI

BBjCEdit

BBjControl

Object Variables

EVENTMASK Mnemonic - Change Event Mask

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.