VerticalScrollBar Class

Create a vertical scroll bar.

Inheritance Hierarchy

Object
  VObject
    Control
      ScrollBar
        VerticalScrollBar

Namespace: VO
Assembly: VOGUIClasses (in VOGUIClasses.dll) Version: 2.21

Syntax

Copy

 CLASS VerticalScrollBar INHERIT ScrollBar

public class VerticalScrollBar : ScrollBar

Request Example View Source

The VerticalScrollBar type exposes the following members.

Constructors

	Name	Description
	VerticalScrollBar	Construct a vertical scroll bar.

Top

Properties

	Name	Description
	Background	The brush used for painting the background of the control. For example, in a single line edit control, the background is the color behind the text in the edit control. (Inherited from Control.)
	BlockSize	A numeric value representing the block size of the scroll bar (Inherited from ScrollBar.)
	Caption	A string representing the caption of the control (i.e., the static text identifying the control) (Inherited from Control.)
	ContextMenu	A menu object representing the local pop-up menu for a control. (Inherited from Control.)
	ControlID	A number between 1 and 8000 representing the unique ID of a control (Inherited from Control.)
	FieldSpec	The field specification connected to the control. (Inherited from Control.)
	HyperLabel	The hyperlabel connected to the control. (Inherited from Control.)
	Modified	A logical value that is set to TRUE when a standard edit control or editable combo box is in the process of being modified. (Inherited from Control.)
	Name	A string representing the name of the control. (Inherited from Control.)
	NameSym	A symbol representing the name of the control. (Inherited from Control.)
	Origin	A point representing the location of a control on its owner window, in canvas coordinates. (Inherited from Control.)
	Owner	The owner window of a control. (Inherited from Control.)
	OwnerAlignment	Constant representing how the window will be aligned within its owner window. (Inherited from Control.)
	Range	A range object representing the minimum and maximum values currently in use for the thumb of a scroll bar. (Inherited from ScrollBar.)
	ReadOnly	Is the control readonly ? (Inherited from Control.)
	Server	The server object that currently connected to this control. If no server is connected, the value is NIL. (Inherited from Control.)
	Size	A dimension representing the size of a control. (Inherited from Control.)
	Status	A hyperlabel indicating the status of the control after a validation attempt or other action. (Inherited from Control.)
	TextValue	A string representing the thumb position of the scroll bar. (Inherited from ScrollBar.)
	ThumbPosition	A numeric value (short integer) representing the current thumb position of the scroll bar. (Inherited from ScrollBar.)
	ToolTipText	String value representing the tooltip text used when the user moves the mouse pointer over the control. (Inherited from Control.)
	UnitSize	A numeric value representing the unit size currently associated with the scroll bar. (Inherited from ScrollBar.)
	UseHLForToolTip	Logical value determining whether the descriptive text of a control's Hyperlabel should be used as the tooltip text. (Inherited from Control.)
	Value	The value held in the control, in whatever data type the control holds. (Inherited from ScrollBar.)
	ValueChanged	A logical value representing whether the control's Value has been changed from its prior setting. (Inherited from Control.)

Top

Methods

	Name	Description
	Activate	Provide a method that is invoked when the control has focus and a window is activated. (Inherited from Control.)
	AsString	Return the contents of the control (or its identifying label). (Inherited from Control.)
	Create	Creates the underlying Win32 control (Inherited from ScrollBar.)
	Deactivate	Provide a method that is invoked when the control has focus and a window is deactivated. (Inherited from Control.)
	DEFAULT	Call the default windows procedure for a control and set the EventReturnValue. (Inherited from Control.)
	Destroy	Provide a method to de-instantiate any Control object. (Inherited from Control.)
	Disable	Disable a control (until a subsequent call to Control:Enable()). (Inherited from Control.)
	DisableTheme	Disable the WinXP theme for a control. (Inherited from Control.)
	Dispatch	Provide the prototype dispatcher for events within the system when the control has focus; routing various events to their appropriate event handlers. (Inherited from Control.)
	Enable	Enable a control that was previously disabled. (Inherited from Control.)
	Expose	Provide a method that is invoked when the control has focus and whenever part of the window needs repainting. (Inherited from Control.)
	FocusChange	Provide a method that is invoked when the control has focus and the input focus changes from the current control to another (or vice versa). (Inherited from Control.)
	GetExStyle	Retrieve the Ex styles for the control. (Inherited from Control.)
	GetStyle	Retrieve the styles for the control. (Inherited from Control.)
	Handle	Return the handle for a control. (Inherited from Control.)
	HasBorder	Check if a border has been set for the control (Inherited from Control.)
	HasStyle	Check if a style value has been set for the control (Inherited from Control.)
	Hide	Hide a control so it is not visible (until a subsequent call to Control:Show()). (Inherited from ScrollBar.)
	HorizontalScroll	Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled. (Inherited from Control.)
	IsEnabled	Report if this control is currently enabled. (Inherited from Control.)
	IsExStyle	Check if a exstyle value has been set for the control (Inherited from Control.)
	IsReadOnly	Report if this control is currently readonly. (Inherited from Control.)
	IsStyle	Check if a style value has been set for the control (Inherited from Control.)
	IsVisible	Report if this control is visible (completely or partially) or hidden. (Inherited from Control.)
	KeyDown	Provide a method that is invoked when the control has focus and a key on the keyboard is pressed. (Inherited from Control.)
	KeyUp	Provide a method that is invoked when the control has focus and a key on the keyboard is released. (Inherited from Control.)
	LinkDF	Connect a control to a data field in a data server. (Inherited from Control.)
	MenuInit	Provide a method that is invoked when a pop-up menu owned by the control is about to pop up. (Inherited from Control.)
	MenuSelect	Provide a method that is invoked when an item on a menu owned by the control is highlighted. (Inherited from Control.)
	MouseButtonDoubleClick	Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is double-clicked. (Inherited from Control.)
	MouseButtonDown	Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is clicked. (Inherited from Control.)
	MouseButtonUp	Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is released. (Inherited from Control.)
	MouseDrag	Provide a method that is invoked when the control has focus and a mouse with one or more buttons clicked is moved in the window. (Inherited from Control.)
	MouseMove	Provide a method that is invoked when the control has focus and the mouse is moved in the control. (Inherited from Control.)
	Move	Provide a method that is invoked when the control has focus and the control is moved (either by the user or by the application). (Inherited from Control.)
	OverRide	This is a compatibility method that is no longer used or needed. (Inherited from Control.)
	PerformValidations	Perform all the validations defined to this control's field specification (for example, required, maximum and minimum digits, maximum and minimum value, validation rule) and return the result of the test. (Inherited from Control.)
	RegisterTimer	Register a timer method to be invoked for the control. (Inherited from Control.)
	RePaint	Send an ExposeEvent to repaint the control (Inherited from Control.)
	Resize	Provide a method that is invoked when the control has focus and the control changes size. (Inherited from Control.)
	RestoreUpdate	Resume all drawing updates for a control (after Control:SuspendUpdate() is called). (Inherited from Control.)
	SetExStyle	Set the exstyle for the control. (Inherited from Control.)
	SetFocus	Pass input focus to a control, thereby directing all mouse and keyboard input to the control. (Inherited from Control.)
	SetInfo	Set all scrollbar properties with one method call. (Inherited from ScrollBar.)
	SetParent	Change the parent handle for the control. (Inherited from Control.)
	SetStyle	Set the style for the control. (Inherited from Control.)
	SetThumbPosition	Set the thumb position of the scrollbar (Inherited from ScrollBar.)
	Show	Display a control so it is visible. (Inherited from ScrollBar.)
	SuspendUpdate	Temporarily suspend all drawing updates for a control; drawing resumes with a call to Control:RestoreUpdate(). (Inherited from Control.)
	Timer	Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method. (Inherited from Control.)
	ValidateControl	This method validates if the control has been created and when not then it triggers the control creation (Inherited from Control.)
	VerticalScroll	Provide a method that is invoked when the control has focus and a vertical scroll bar is scrolled. (Inherited from Control.)

Top

Fields

	Name	Description
	EventReturnValue	(Inherited from Control.)
	oCargo	Cargo slot. (Inherited from VObject.)

Top

Remarks

There are two types of vertical scroll bars in X#: regular (created with CLASS VerticalScrollBar) and window (created with the AppWindow:EnableVerticalScroll() method). Both types have an owner window and can be manipulated using Window:VerticalScroll(). However, a window vertical scroll bar differs in that it automatically appears aligned along the right side of its owner window's canvas area and also resizes itself according to the size of its owner window. A vertical scroll bar allows the user to update a short integer numeric value by either moving the thumb position, clicking on the button at either end of the scroll bar to change the number by the designated ScrollBar:UnitSize, or by clicking in the interior of the scroll bar to change the number by the designated ScrollBar:BlockSize. The minimum and maximum allowable numeric values are indicated by the Min and Max values for the Range object associated with the scroll bar. The ScrollBar:Value access indicates the currently selected numeric value. A scroll bar may be bound to a numeric field in a server.

Tip
By default, Window:VerticalScroll() updates the thumb position in the scroll bar; if desired, you can change this by using your own implementation of this handler.

In Windows, vertical scroll bars are equivalent to a scroll bar with the SBS_VERT style. These are normally specified in the resource entity like this:

Copy

1RESOURCE IDD_ABOUT DIALOG 20, 20, 160, 120
2STYLE WS_POPUP | WS_DLGFRAME
3BEGIN
4CONTROL "", IDS_RED, "scrollbar", SBS_VERT, 10, 16, 24, 100
5END

Reference

VO Namespace