StatusBar Class (Typed)

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.21

Syntax

Copy

 CLASS StatusBar INHERIT Control

public class StatusBar : Control

Request Example View Source

The StatusBar type exposes the following members.

Constructors

	Name	Description
	StatusBar	Construct a status bar.

Top

Properties

	Name	Description
	AsString
	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.)
	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.)
	ControlText	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.
	DisabledKeyIndicatorColor	The Color object that the status bar uses to indicate that a key is disabled. The default is gray.
	ErrorMessageBeep	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.
	ErrorText	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.
	EventReturnValue	(Inherited from Control.)
	FieldSpec	(Inherited from Control.)
	HasFocus	(Inherited from Control.)
	HorizontalBorder	A numeric value representing the width of the horizontal border between the top or bottom edge of the status bar and its items.
	HyperLabel	The hyperlabel connected to the control. (Inherited from Control.)
	InsertMode	A logical value indicating whether the program is in insert mode.
	IsHidden	(Inherited from Control.)
	ItemBorder	A numeric value representing the width of the borders between the status bar items.
	KeyIndicatorColor	The Color object that the status bar uses to indicate to the user that a key is in the on state.
	Length	A numeric value representing the number of characters in the message to be displayed on the status bar.
	MenuText	A string representing a message associated with a menu selection to be displayed on the status bar.
	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.)
	Parent	(Inherited from Control.)
	PermanentText	A string representing the default message to be displayed on the status bar
	Position	A pair representing the coordinates to be shown in the status bar. The units you choose for coordinates are arbitrary.
	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.)
	SWFControl	(Inherited from Control.)
	TextValue	A string representing the value held in the status bar. (Overrides TextValue.)
	TimeOut	A numeric value indicating the number of seconds a nonpermanent message is displayed on the status bar.
	ToolTipText	String value representing the tooltip text used when the user moves the mouse pointer over the control. (Inherited from Control.)
	Transient	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.
	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 Control.)
	ValueChanged	(Inherited from Control.)
	VerticalBorder	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

	Name	Description
	Activate	Provide a method that is invoked when the control has focus and a window is activated. (Inherited from Control.)
	AddChild	(Inherited from Control.)
	AddItem	Add a new item to the status bar.
	AsString	(Inherited from Control.)
	BringToFront	(Inherited from Control.)
	ClearItems	Remove all of the status bar items.
	Create	Creates the underlying Win32 control (Inherited from Control.)
	CreateWindowEx	(Inherited from Control.)
	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 a StatusBar object. (Overrides Destroy.)
	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.)
	DisplayKeyboard	Enable the display of the keyboard state on the status bar.
	DisplayMemory	Enable the display of the virtual memory available, on the status bar. You must keep the display refreshed as necessary by calling StatusBar:RefreshMemoryDisplay().
	DisplayMessage	Enable the display of messages on the status bar.
	DisplayPosition	Enable the display of a coordinate pair on the status bar.
	DisplayTime	Enable the digital clock display on the status bar.
	Drop	(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.)
	GetItemBoundingBox	Get the bounding box that describes the area of a status bar item.
	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 Control.)
	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.)
	IsReadOnly	Report if this control is currently readonly. (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.)
	OnHandleCreated	(Inherited from Control.)
	OnHandleDestroyed	(Inherited from Control.)
	OverRide	This is a compatibility method that is no longer used or needed. (Inherited from Control.)
	PaintBackGround	(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.)
	RefreshMemoryDisplay	Cause the status bar to bring the display of virtual memory up-to-date.
	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.)
	SendToBack	(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.)
	SetMessage	Display a string in the main message area of the status bar.
	SetPair	Set a pair representing the coordinates to be shown in the status bar.
	SetStyle	Set the style for the control. (Inherited from Control.)
	SetText	Set text for a status bar item.
	Show	Display a status bar so it is visible. (Overrides Show.)
	ShowToolTip	(Inherited from Control.)
	SuspendUpdate	Temporarily suspend all drawing updates for a control; drawing resumes with a call to Control:RestoreUpdate(). (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

Globals and Defines

	Name	Description
	oCargo	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
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.

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.

Reference

XSharp.VO.SDK Namespace