Click or drag to resize

ScrollBar Class (Typed)

X#
Provide the base class from which all X# scroll bars are subclassed.
Inheritance Hierarchy
Object
  VObject
    Control
      ScrollBar
        HorizontalScrollBar
        Slider
        VerticalScrollBar
        WindowScrollBar

Namespace:  XSharp.VO.SDK
Assembly:  XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.19
Syntax
 ABSTRACT CLASS ScrollBar INHERIT Control
Request Example View Source

The ScrollBar type exposes the following members.

Constructors
  NameDescription
Public methodScrollBar
Construct a scroll bar.
Top
Properties
  NameDescription
Public propertyBackground
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.)
Public propertyBlockSize
A numeric value representing the block size of the scroll bar
Public propertyCaption
A string representing the caption of the control (i.e., the static text identifying the control)
(Inherited from Control.)
Public propertyContextMenu
A menu object representing the local pop-up menu for a control.
(Inherited from Control.)
Public propertyControlID
A number between 1 and 8000 representing the unique ID of a control
(Inherited from Control.)
Public propertyControlType (Inherited from Control.)
Public propertyEventReturnValue (Inherited from Control.)
Public propertyFieldSpec (Inherited from Control.)
Public propertyHasFocus (Inherited from Control.)
Public propertyHyperLabel
The hyperlabel connected to the control.
(Inherited from Control.)
Public propertyIsHidden (Inherited from Control.)
Public propertyModified
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.)
Public propertyName
A string representing the name of the control.
(Inherited from Control.)
Public propertyNameSym
A symbol representing the name of the control.
(Inherited from Control.)
Public propertyOrigin
A point representing the location of a control on its owner window, in canvas coordinates.
(Inherited from Control.)
Public propertyOwner
The owner window of a control.
(Inherited from Control.)
Public propertyOwnerAlignment
Constant representing how the window will be aligned within its owner window.
(Inherited from Control.)
Public propertyParent (Inherited from Control.)
Public propertyRange
A range object representing the minimum and maximum values currently in use for the thumb of a scroll bar.
Public propertyReadOnly
Is the control readonly ?
(Inherited from Control.)
Public propertyServer
The server object that currently connected to this control. If no server is connected, the value is NIL.
(Inherited from Control.)
Public propertySize
A dimension representing the size of a control.
(Inherited from Control.)
Public propertyStatus
A hyperlabel indicating the status of the control after a validation attempt or other action.
(Inherited from Control.)
Public propertySWFControl (Inherited from Control.)
Public propertyTextValue
A string representing the thumb position of the scroll bar.
(Overrides TextValue.)
Public propertyThumbPosition
A numeric value (short integer) representing the current thumb position of the scroll bar.
Public propertyToolTipText
String value representing the tooltip text used when the user moves the mouse pointer over the control.
(Inherited from Control.)
Public propertyUnitSize
A numeric value representing the unit size currently associated with the scroll bar.
Public propertyUseHLForToolTip
Logical value determining whether the descriptive text of a control's Hyperlabel should be used as the tooltip text.
(Inherited from Control.)
Public propertyCode exampleValue
The value held in the control, in whatever data type the control holds.
(Overrides Value.)
Public propertyValueChanged (Inherited from Control.)
Top
Functions
  NameDescription
Public methodActivate
Provide a method that is invoked when the control has focus and a window is activated.

(Inherited from Control.)
Public methodAddChild (Inherited from Control.)
Public methodAsString (Inherited from Control.)
Public methodBringToFront (Inherited from Control.)
Public methodCreate
Creates the underlying Win32 control
(Inherited from Control.)
Public methodCreateWindowEx (Inherited from Control.)
Public methodDeactivate
Provide a method that is invoked when the control has focus and a window is deactivated.

(Inherited from Control.)
Public methodDefault
Call the default windows procedure for a control and set the EventReturnValue.
(Inherited from Control.)
Public methodDestroy
Provide a method to de-instantiate any Control object.
(Inherited from Control.)
Public methodDisable
Disable a control (until a subsequent call to Control:Enable()).
(Inherited from Control.)
Public methodDisableTheme
Disable the WinXP theme for a control.
(Inherited from Control.)
Public methodDispatch
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.)
Public methodDrop (Inherited from Control.)
Public methodEnable
Enable a control that was previously disabled.
(Inherited from Control.)
Public methodExpose
Provide a method that is invoked when the control has focus and whenever part of the window needs repainting.

(Inherited from Control.)
Public methodFocusChange
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.)
Public methodHandle
Return the handle for a control.
(Inherited from Control.)
Public methodHasBorder
Check if a border has been set for the control
(Inherited from Control.)
Public methodHasStyle
Check if a style value has been set for the control
(Inherited from Control.)
Public methodHide
Hide a control so it is not visible (until a subsequent call to Control:Show()).
(Inherited from Control.)
Public methodHorizontalScroll
Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled.

(Inherited from Control.)
Public methodIsEnabled
Report if this control is currently enabled.
(Inherited from Control.)
Public methodIsReadOnly
Report if this control is currently readonly.
(Inherited from Control.)
Public methodIsVisible
Report if this control is visible (completely or partially) or hidden.
(Inherited from Control.)
Public methodKeyDown
Provide a method that is invoked when the control has focus and a key on the keyboard is pressed.

(Inherited from Control.)
Public methodKeyUp
Provide a method that is invoked when the control has focus and a key on the keyboard is released.

(Inherited from Control.)
Public methodLinkDF
Connect a control to a data field in a data server.
(Inherited from Control.)
Public methodMenuInit
Provide a method that is invoked when a pop-up menu owned by the control is about to pop up.
(Inherited from Control.)
Public methodMenuSelect
Provide a method that is invoked when an item on a menu owned by the control is highlighted.
(Inherited from Control.)
Public methodMouseButtonDoubleClick
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.)
Public methodMouseButtonDown
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.)
Public methodMouseButtonUp
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.)
Public methodMouseDrag
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.)
Public methodMouseMove
Provide a method that is invoked when the control has focus and the mouse is moved in the control.
(Inherited from Control.)
Public methodMove
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.)
Public methodOnControlCreated (Inherited from Control.)
Public methodOnHandleCreated (Inherited from Control.)
Public methodOnHandleDestroyed (Inherited from Control.)
Public methodOverRide
This is a compatibility method that is no longer used or needed.
(Inherited from Control.)
Public methodPaintBackGround (Inherited from Control.)
Public methodPerformValidations
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.)
Public methodRegisterTimer
Register a timer method to be invoked for the control.
(Inherited from Control.)
Public methodRePaint
Send an ExposeEvent to repaint the control
(Inherited from Control.)
Public methodResize
Provide a method that is invoked when the control has focus and the control changes size.
(Inherited from Control.)
Public methodRestoreUpdate
Resume all drawing updates for a control (after Control:SuspendUpdate() is called).
(Inherited from Control.)
Public methodSendToBack (Inherited from Control.)
Public methodSetExStyle
Set the exstyle for the control.
(Inherited from Control.)
Public methodSetFocus
Pass input focus to a control, thereby directing all mouse and keyboard input to the control.
(Inherited from Control.)
Public methodSetInfo
Set all scrollbar properties with one method call.
Public methodSetStyle
Set the style for the control.
(Inherited from Control.)
Public methodSetThumbPosition
Set the thumb position of the scrollbar
Public methodShow
Display a control so it is visible.
(Inherited from Control.)
Public methodShowToolTip (Inherited from Control.)
Public methodSuspendUpdate
Temporarily suspend all drawing updates for a control; drawing resumes with a call to Control:RestoreUpdate().
(Inherited from Control.)
Public methodTimer
Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method.
(Inherited from Control.)
Public methodValidateControl
This method validates if the control has been created and when not then it triggers the control creation
(Inherited from Control.)
Public methodVerticalScroll
Provide a method that is invoked when the control has focus and a vertical scroll bar is scrolled.
(Inherited from Control.)
Top
Globals and Defines
  NameDescription
Public fieldoCargo
Cargo slot.
(Inherited from VObject.)
Top
Remarks
Scroll bars have a marker, called a thumb, which can be dragged up and down (or left and right) within a range of values. The thumb can be dragged to different positions on the scroll bar, or it can step up or down in blocks or units. GUI scroll bars automatically maintain block and unit operations. When a block or unit operation takes place, a ScrollEvent is generated with both the actual thumb position and the position the thumb would assume if the scroll bar is updated. The block and unit amounts are added or subtracted from the current position according to the scroll type that occurs. By default, a scroll bar has a range of (0,99), a unit size of 1, a block size of 10, and an initial thumb position of 0.
See Also