Click or drag to resize

StatusBar Class (Typed)

X#
Create a status bar for use in a window.
Inheritance Hierarchy
Object
  VObject
    Control
      StatusBar

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

The StatusBar type exposes the following members.

Constructors
  NameDescription
Public methodStatusBar
Construct a status bar.
Top
Properties
  NameDescription
Public propertyAsString
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 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 propertyControlText
A string representing a message associated with a control to be displayed on the status bar. This message takes priority over the StatusBar:PermanentText message.
Public propertyDisabledKeyIndicatorColor
The Color object that the status bar uses to indicate that a key is disabled. The default is gray.
Public propertyErrorMessageBeep
A logical value determining whether a beep is sounded by the error system when an error occurs. TRUE turns beeping on; FALSE turns it off.
Public propertyErrorText
A string representing an error message to be displayed on the status bar. This message takes priority over the StatusBar:ControlText and StatusBar:PermanentText messages.
Public propertyEventReturnValue (Inherited from Control.)
Public propertyFieldSpec (Inherited from Control.)
Public propertyHasFocus (Inherited from Control.)
Public propertyHorizontalBorder
A numeric value representing the width of the horizontal border between the top or bottom edge of the status bar and its items.
Public propertyHyperLabel
The hyperlabel connected to the control.
(Inherited from Control.)
Public propertyInsertMode
A logical value indicating whether the program is in insert mode.
Public propertyIsHidden (Inherited from Control.)
Public propertyItemBorder
A numeric value representing the width of the borders between the status bar items.
Public propertyKeyIndicatorColor
The Color object that the status bar uses to indicate to the user that a key is in the on state.
Public propertyLength
A numeric value representing the number of characters in the message to be displayed on the status bar.
Public propertyMenuText
A string representing a message associated with a menu selection to be displayed on the status bar.
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 propertyPermanentText
A string representing the default message to be displayed on the status bar
Public propertyPosition
A pair representing the coordinates to be shown in the status bar. The units you choose for coordinates are arbitrary.
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 value held in the status bar.
(Overrides TextValue.)
Public propertyTimeOut
A numeric value indicating the number of seconds a nonpermanent message is displayed on the status bar.
Public propertyToolTipText
String value representing the tooltip text used when the user moves the mouse pointer over the control.
(Inherited from Control.)
Public propertyTransient
A string representing an error message to be displayed on the status bar. This message takes priority over the StatusBar:ControlText and StatusBar:PermanentText messages.
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.
(Inherited from Control.)
Public propertyValueChanged (Inherited from Control.)
Public propertyVerticalBorder
A numeric value representing the height of the vertical border between the left or right edge of the status bar and its items.
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 methodAddItem
Add a new item to the status bar.
Public methodAsString (Inherited from Control.)
Public methodBringToFront (Inherited from Control.)
Public methodClearItems
Remove all of the status bar items.
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 a StatusBar object.
(Overrides Destroy.)
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 methodDisplayKeyboard
Enable the display of the keyboard state on the status bar.
Public methodDisplayMemory
Enable the display of the virtual memory available, on the status bar. You must keep the display refreshed as necessary by calling StatusBar:RefreshMemoryDisplay().
Public methodDisplayMessage
Enable the display of messages on the status bar.
Public methodDisplayPosition
Enable the display of a coordinate pair on the status bar.
Public methodDisplayTime
Enable the digital clock display on the status bar.
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 methodGetItemBoundingBox
Get the bounding box that describes the area of a status bar item.
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 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 methodRefreshMemoryDisplay
Cause the status bar to bring the display of virtual memory up-to-date.
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 methodSetMessage
Display a string in the main message area of the status bar.
Public methodSetPair
Set a pair representing the coordinates to be shown in the status bar.
Public methodSetStyle
Set the style for the control.
(Inherited from Control.)
Public methodSetText
Set text for a status bar item.
Public methodShow
Display a status bar so it is visible.
(Overrides Show.)
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 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
A status bar is the shallow bar that appears usually at the bottom of a window to provide status information to the user without taking up much screen "real-estate." Visual Object's status bar class has methods to present the following kinds of information: Status messages (permanent or transient) Time Keyboard state (NumLock, CapsLock, ScrollLock, and Insert keys) Virtual memory available A screen coordinate reading The sequence in which you call the various Display… methods determines the left-to-right order in which the corresponding items appear upon the status bar. Any transient status message overrides the StatusBar:PermanentText status message, but it times out after five seconds.
Tip Tip
You never create a status bar yourself. Instead, you ask the window to do it, by calling AppWindow:EnableStatusBar(). Once you pick up the status bar returned by that method, you can customize the status bar by invoking the various Display… methods of status bar. Note that, except for the time display, the status bar items require you to refresh them. For example, if you turn on the display of available virtual memory, you must call the StatusBar:RefreshMemoryDisplay() method whenever the application is about to embark on a "memory-hungry" task. Because you never create status bars, you also never destroy them—the window does that itself.
See Also