BBjScrollBar::getScrollMaximum

Description

Returns the maximum range of the BBjScrollBar control.

Syntax

Return Value

Method

int

getScrollMaximum()

Parameters

None.

Return Value

Returns the maximum range of the scroll bar.

Example

rem 'Get the maximum range 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()
    SCROLL_MINIMUM = myVScrollBar!.getScrollMinimum()
    SCROLL_MAXIMUM = myVScrollBar!.getScrollMaximum()
return

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.