VRScroll

The Scroll Object allows you to add scrollbars to a frame window or to use them as stand alone objects.

Properties
The Scroll Object has the following properties:


 * FrameControl
 * LineIncrement
 * MaximumValue
 * MinimumValue
 * Orientation
 * PageIncrement
 * StandardSize
 * ThumbSize

The current position of the slider in the scrollbar is available through the Value property and can also be set using the Value property.

FrameControl
When set to 1, this property will cause the scrollbar to become a frame control of its parent window in the runtime environment. The Scroll Object remains free floating in the design environment.


 * Data Type : Boolean


 * Possible Values
 * 1 (true)
 * 0 (false)

LineIncrement
This value defines the incrementation/decrementation of the Value of the Scroll Object when either the arrows are clicked or a cursor key is pressed.

This value should not be greater than the value in the MaximumValue property and should normaly be less than that of the PageIncrement property.


 * Data Type : Numeric


 * Possible Values : 0 - 32737

MaximumValue
This property defines the maximum Value of the Scroll Object when the slider is at the bottom or right of the scrollbar.


 * Data Type : Numeric


 * Possible Values : 0 - 32737

MinimumValue
This property defines the minimum Value of the Scroll Object when the slider is at the top or left of the scrollbar.


 * Data Type : Numeric


 * Possible Values : 0 - 32737

Orientation
This property defines the orientation of the Scroll Object. You can also set this property using the first character of the word (V or H).


 * Data Type : String


 * Possible Values :
 * Vertical (default)
 * Horizontal

PageIncrement
This value defines the incrementation/decrementation of the Value of the Scroll Object when either the bar is clicked or a pageup/pagedown key is pressed.

This value should not be greater than the value in the MaximumValue property and should normaly be greater than that of the LineIncrement property.


 * Data Type : Numeric


 * Possible Values : 0 - 32737

StandardSize
This property is set by default making a Scroll Object that is dropped on a window a sensible size. The property is ignored in the runtime environment if the Scroll Object is a FrameControl.


 * Data Type : Boolean


 * Possible Values
 * 1 (true)
 * 0 (false)

ThumbSize
This defines the proportion of the ScrollBar Objects's height or width that is occupied by the slider as a percentage.


 * Data Type : Numeric


 * Possible Values : 0 - 100

Events
The Scroll Object generates the following events when manipulated in the runtime environment:


 * Change : The change event is posted whenever the positon of the thumb bar is changed, either by clicking the arrows, the bar itself or pressing a cursor key when the Scroll Object has the focus. The Value property of the Scroll Object is updated at the same time.


 * Track : The track event is posted whenever the Scroll Object's slider is dragged. The Value property of the Scroll Object is updated at the same time.

Methods
The Scroll Object exports the following method:

AttachToWindow
This method will attach the Scroll Object to the frame of its parent window as a frame control. Once a Scroll Object has been converted to a frame control, it cannot be moved or detached.

Note: This method is called during the initialisation of a Scroll Object if the FrameControl property is set. It should, therefore, rarely be necessary to call this method.

ok = VRMethod( object, "AttachToWindow");


 * Returns
 * 1 (true) if successful
 * 0 (false) if fails