BBjScrollBar::getScrollPosition

Description

Returns the thumb position of the BBjScrollBar control.

Syntax

Return Value

Method

int

getScrollPosition()

Parameters

None.

Return Value

Returns the thumb position of the scroll bar.

Remarks

None.

Example

REM Get the scroll position of a scrollbar

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 vertical scrollbar on the window
myVScrollBar! = myWindow!.addVerticalScrollBar(101,180,0,20,200,$0000$)

REM Register the CALLBACK routines
CALLBACK(ON_CONTROL_SCROLL,SCROLLBAR_SCROLLED,mySysGui!.getContext(),myVScrollBar!.getID())
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())

REM Process Events
PROCESS_EVENTS

REM Callback routine called when the scrollbar is used to scroll
SCROLLBAR_SCROLLED:
REM Get the scroll position of the scrollbar
SCROLL_POSITION = myVScrollBar!.getScrollPosition()
RETURN

REM Callback routine called when the user closes the application window
APP_CLOSE:
RELEASE
RETURN

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.