ToolBar Class |
Namespace: VO
The ToolBar type exposes the following members.
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.) | |
BandCount |
The number of bands in the toolbar.
| |
BandImageList |
An Image List object used for the bands.
| |
Bitmap |
The Bitmap object (containing a bitmap ribbon with one or more button images) that will be used to display buttons on the toolbar. If not assigned, the default bitmap is used.
| |
BorderStyle |
This property is no longer supported. It is included only for compatibility with existing X#1.0 code.
| |
BoundingBox |
The bounding box, in canvas coordinates, representing the minimal area that encloses the toolbar.
| |
ButtonCount |
A numeric value representing the number of buttons currently on the toolbar.
| |
ButtonSize |
A Dimension object representing the size of buttons on the toolbar. If not assigned, the default is a 16 by 16 button.
| |
ButtonStyle |
A constant that represents how the buttons are displayed:
| |
Caption |
A string representing the caption of the control (i.e., the static text identifying the control)
(Inherited from Control.) | |
ClientArea |
A bounding box (group or character box) representing the area of its parent window that remains available given the placement of the toolbar.
| |
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.) | |
GapSize |
This property is no longer supported. It is included only for compatibility with existing X#1.0 code.
| |
HyperLabel |
The hyperlabel connected to the control.
(Inherited from Control.) | |
ImageCount |
A numeric value representing the number of images in the toolbar bitmap. If a custom bitmap has been assigned to the toolbar, this value must be assigned as the number of images in that bitmap.
| |
Location |
This property is no longer supported. It is included only for compatibility with existing X#1.0 code.
| |
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.) | |
ReadOnly |
Is the control readonly ?
(Inherited from Control.) | |
Rows |
A numeric value representing the number of rows of buttons on the toolbar.
Note that Rows now has an optional parameter, <symTB>, to indicate which toolbar, or sub-toolbar, to query. If not specified, #MAINTOOLBAR is assumed.
| |
SeparatorSize |
This property is no longer supported. It is included only for compatibility with existing X#1.0 code.
| |
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 value held in the control.
(Inherited from Control.) | |
ToolTipText |
String value representing the tooltip text used when the user moves the mouse pointer over the control.
(Inherited from Control.) | |
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 |
A logical value representing whether the control's Value has been changed from its prior setting.
(Inherited from Control.) |
Name | Description | |
---|---|---|
Activate |
Provide a method that is invoked when the control has focus and a window is activated. (Inherited from Control.) | |
AddBand |
Use this method to add a band to the ToolBar.
| |
AddSubToolBarBand |
Add a new band to the toolbar as a sub-toolbar.
| |
AddTipText |
Add a string to be displayed as tip text for a button.
| |
AppendItem |
Add a new toolbar button item to the end of the toolbar from the list of buttons available.
| |
AsString |
Return the contents of the control (or its identifying label).
(Inherited from Control.) | |
ChangeTipText |
Change the current tip text for a button.
| |
ClickItem |
Make a button look like it is has been clicked, indicating that it has been selected.
| |
Configure |
This method is no longer supported. It is included only for compatibility with existing X#1.0 code.
| |
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.) | |
DeleteItem |
Remove a button from the toolbar.
| |
Destroy |
Provide a method to de-instantiate a ToolBar object.
(Overrides Destroy.) | |
DimItem |
Dim a button.
| |
Disable |
Disable a control (until a subsequent call to Control:Enable()).
(Inherited from Control.) | |
DisableItem |
Disable a button.
| |
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.) | |
EnableBands |
Enable toolbar band support.
| |
EnableDrag |
Allow the user to move the toolbar around with the mouse.
| |
EnableItem |
Enable a button that has been disabled.
| |
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.) | |
GetButtonDescription |
Retrieve the description of a toolbar button.
| |
GetExStyle |
Retrieve the Ex styles for the control.
(Inherited from Control.) | |
GetImageList |
Gets the ImageList that is specified by the parameters passed.
| |
GetStyle |
Retrieve the styles for the control.
(Inherited from Control.) | |
GetTipText |
Return the current tip text for a button.
| |
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 toolbar so it is not visible.
(Overrides Hide.) | |
HideItem |
Hide a button.
| |
HorizontalScroll |
Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled. (Inherited from Control.) | |
InsertItem |
Insert a new toolbar button item before a specified toolbar button item, from the list of buttons available.
| |
IsClicked |
Return a logical value indicating whether the specified button is currently clicked or selected.
| |
IsDimmed |
Determine whether a button is dimmed.
| |
IsEnabled |
Report if this control is currently enabled.
(Inherited from Control.) | |
IsEnabled(Usual, Usual, Usual) |
Return a logical value indicating whether the specified button is currently enabled.
| |
IsExStyle | Check if a exstyle value has been set for the control (Inherited from Control.) | |
IsHidden |
Determine whether a button is hidden.
| |
IsPressed |
Determine whether a button is pressed.
| |
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.) | |
PressItem |
Press a button.
| |
RegisterTimer |
Register a timer method to be invoked for the control.
(Inherited from Control.) | |
RemoveTipText |
Remove the current tip text for a button.
| |
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.) | |
SetImageList |
Sets the ImageList to be used by the ToolBar.
| |
SetParent |
Change the parent handle for the control.
(Inherited from Control.) | |
SetStyle |
Set the style for the control.
(Inherited from Control.) | |
Show |
Display a toolbar so it is visible.
(Overrides Show.) | |
ShowItem |
Show a button.
| |
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.) | |
UnClickItem |
Make a button look like it is "clicked-out" (returned to its normal state) after it has been "clicked-in" to indicate that it has been selected.
| |
UnDimItem |
Undim a button.
| |
UnPressItem |
Unpress a button.
| |
Update |
This method is no longer supported. It is included only for compatibility with existing X#1.0 code.
| |
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.) |
Name | Description | |
---|---|---|
Divider | ||
EventReturnValue | (Inherited from Control.) | |
oCargo | Cargo slot. (Inherited from VObject.) |
1METHOD Init(oWOwner) CLASS MyWindow 2... 3SELF:Menu := MyMenu{} 4... 5METHOD Init() CLASS MyMenu 6... 7SELF:ToolBar := ToolBar{}
Tip |
---|
This is not necessarily the window that owns the toolbar or menu. |