VScrollBar control

A VScrollBar is a vertical bar with arrows at either end and a scroll box. Typically, you would use a VScrollBar control as a slider control for users to specify a value on a continuous scale, or as a way to graphically display information to the user.

Usage note The VScrollBar control is not the vertical scroll bar that displays to allow the user to scroll through information in a control or window.

Properties

VScrollBar property	Datatype	Description
AccessibleDescription	String	A description of the control and/or its purpose for use by accessibility tools such as readers for visually impaired users.
AccessibleName	String	A label that briefly describes the control, such as the text in a button or the name of a menu item.
AccessibleRole	AccessibleRole (enumerated)	Describes what kind of user interface element the control is.
BringToTop	Boolean	Specifies whether PowerBuilder moves the control to the top of the front-to-back order of the window. Values are: TRUE – Control moved to top. FALSE – Control not moved to top.
ClassDefinition	PowerObject	An object of type PowerObject containing information about the class definition of the object or control.
DragAuto	Boolean	Specifies whether PowerBuilder puts the control automatically into Drag mode. Values are: TRUE – When the control is clicked, the control is automatically in Drag mode. FALSE – When the control is clicked, the control is not automatically in Drag mode. You have to manually put the control into Drag mode by using the Drag function.
DragIcon	String	Specifies the name of the stock icon or the file containing the icon you want to display when the user drags the control (the ICO file). The default icon is a box the size of the control. When the user drags the control, the icon displays when the control is over an area in which the control can be dropped (a valid drop area). When the control is over an area that is not a valid drop area, the No-Drop icon displays.
Height	Integer	Specifies the height of the control, in PowerBuilder units.
MaxPosition	Integer	Specifies the value of the Position property when the scroll box is at the bottom of the scroll bar.
MinPosition	Integer	Specifies the value of the Position property when the scroll box is at the top of the scroll bar.
Pointer	String	Specifies the name of the stock pointer or the file containing the pointer used for the control.
Position	Integer	Specifies the value between MinPosition and MaxPosition that indicates the position of the scroll box.
StdWidth	Boolean	Specifies whether the standard scroll bar width is used for the VScrollBar. Values are: TRUE – Standard width used. FALSE – Standard width not enforced for the control.
TabOrder	Integer	Specifies the tab value of the control within the window (0 means the user cannot tab to the control).
Tag	String	Specifies the tag value assigned to the control.
Visible	Boolean	Specifies whether the control is visible. Values are: TRUE – Control is visible. FALSE – Control is not visible.
Width	Integer	Specifies the width of the control, in PowerBuilder units.
X	Integer	Specifies the X position (the distance from the left edge of the window), in PowerBuilder units.
Y	Integer	Specifies the Y position (the distance from the top of the window), in PowerBuilder units.

VScrollBar property

Datatype

Description

AccessibleDescription

String

A description of the control and/or its purpose for use by accessibility tools such as readers for visually impaired users.

AccessibleName

String

A label that briefly describes the control, such as the text in a button or the name of a menu item.

AccessibleRole

AccessibleRole (enumerated)

Describes what kind of user interface element the control is.

BringToTop

Boolean

Specifies whether PowerBuilder moves the control to the top of the front-to-back order of the window. Values are:

TRUE – Control moved to top.
FALSE – Control not moved to top.

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

DragAuto

Boolean

Specifies whether PowerBuilder puts the control automatically into Drag mode. Values are:

TRUE – When the control is clicked, the control is automatically in Drag mode.
FALSE – When the control is clicked, the control is not automatically in Drag mode. You have to manually put the control into Drag mode by using the Drag function.

DragIcon

String

Specifies the name of the stock icon or the file containing the icon you want to display when the user drags the control (the ICO file). The default icon is a box the size of the control.

When the user drags the control, the icon displays when the control is over an area in which the control can be dropped (a valid drop area). When the control is over an area that is not a valid drop area, the No-Drop icon displays.

Height

Integer

Specifies the height of the control, in PowerBuilder units.

MaxPosition

Integer

Specifies the value of the Position property when the scroll box is at the bottom of the scroll bar.

MinPosition

Integer

Specifies the value of the Position property when the scroll box is at the top of the scroll bar.

Pointer

String

Specifies the name of the stock pointer or the file containing the pointer used for the control.

Position

Integer

Specifies the value between MinPosition and MaxPosition that indicates the position of the scroll box.

StdWidth

Boolean

Specifies whether the standard scroll bar width is used for the VScrollBar. Values are:

TRUE – Standard width used.
FALSE – Standard width not enforced for the control.

TabOrder

Integer

Specifies the tab value of the control within the window (0 means the user cannot tab to the control).

Tag

String

Specifies the tag value assigned to the control.

Visible

Boolean

Specifies whether the control is visible. Values are:

TRUE – Control is visible.
FALSE – Control is not visible.

Width

Integer

Specifies the width of the control, in PowerBuilder units.

Integer

Specifies the X position (the distance from the left edge of the window), in PowerBuilder units.

Integer

Specifies the Y position (the distance from the top of the window), in PowerBuilder units.

Events

VScrollBar event	Occurs
Constructor	Immediately before the Open event occurs in the window.
Destructor	Immediately after the Close event occurs in the window.
DragDrop	When a dragged control is dropped on the control.
DragEnter	When a dragged control enters the control.
DragLeave	When a dragged control leaves the control.
DragWithin	When a dragged control is within the control.
GetFocus	Just before the control receives focus (before it is selected and becomes active).
Help	When the user presses the F1 key or drags the context help button (question mark) from the title bar to a menu item or control.
LineDown	When the down arrow of the control is clicked.
LineUp	When the up arrow of the control is clicked.
LoseFocus	When the control loses focus (becomes inactive).
Moved	When the scroll box is moved (use the Position property to determine the new location).
Other	When a Windows message occurs that is not a PowerBuilder event.
PageDown	When the open space below the scroll box is clicked.
PageUp	When the open space above the scroll box is clicked.
RButtonDown	When the right mouse button is pressed on the control.

VScrollBar event

Occurs

Constructor

Immediately before the Open event occurs in the window.

Destructor

Immediately after the Close event occurs in the window.

DragDrop

When a dragged control is dropped on the control.

DragEnter

When a dragged control enters the control.

DragLeave

When a dragged control leaves the control.

DragWithin

When a dragged control is within the control.

GetFocus

Just before the control receives focus (before it is selected and becomes active).

Help

When the user presses the F1 key or drags the context help button (question mark) from the title bar to a menu item or control.

LineDown

When the down arrow of the control is clicked.

LineUp

When the up arrow of the control is clicked.

LoseFocus

When the control loses focus (becomes inactive).

Moved

When the scroll box is moved (use the Position property to determine the new location).

Other

When a Windows message occurs that is not a PowerBuilder event.

PageDown

When the open space below the scroll box is clicked.

PageUp

When the open space above the scroll box is clicked.

RButtonDown

When the right mouse button is pressed on the control.

Functions

VScrollBar function	Datatype returned	Description
ClassName	String	Returns the name assigned to the control.
Drag	Integer	Starts or ends the dragging of the control.
GetContextService	Integer	Creates a reference to a context-specific instance of the specified service.
GetParent	PowerObject	Returns a reference to the name of the parent object.
Hide	Integer	Makes the control invisible.
Move	Integer	Moves the control to a specified location.
PointerX	Integer	Returns the distance the pointer is from the left edge of the control.
PointerY	Integer	Returns the distance the pointer is from the top of the control.
PostEvent	Boolean	Adds an event to the end of the message queue for the control.
Print	Integer	Prints the control.
Resize	Integer	Changes the size of the control.
SetFocus	Integer	Sets focus to the specified control.
SetPosition	Integer	Specifies the position of the control in the front-to-back order of the window.
SetRedraw	Integer	Controls automatic redrawing of the control after each change in its properties.
Show	Integer	Makes the control visible.
TriggerEvent	Integer	Triggers a specified event in the control and executes the script for the event.
TypeOf	Object	Returns the type of the control.

VScrollBar function

Datatype returned

Description

ClassName

String

Returns the name assigned to the control.

Drag

Integer

Starts or ends the dragging of the control.

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service.