PushButton Class (Typed) |  |
Create a push button, which can be used to initiate an event and associated action when clicked on by the user.
Inheritance HierarchyNamespace: XSharp.VO.SDK
Assembly: XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.21
SyntaxThe PushButton type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PushButton |
Construct a push button.
|
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.) |
| Caption |
A string representing the text that is displayed adjacent to a check box or radio button, or on top of a push button. The Button:Caption assign also changes Button:CurrentText for the button.
(Inherited from Button.) |
| ContextMenu |
A menu object representing the local pop-up menu for a control.
(Inherited from Control.) |
| ControlFont |
The font used to draw the text in the control.
(Inherited from TextControl.) |
| ControlID |
A number between 1 and 8000 representing the unique ID of a control
(Inherited from Control.) |
| ControlType | (Overrides ControlType.) |
| CurrentText |
For check boxes, push buttons, and radio buttons, Button:CurrentText contains NULL_STRING.
(Inherited from Button.) |
| EventReturnValue | (Inherited from Control.) |
| FieldSpec | (Inherited from Control.) |
| HasFocus | (Inherited from Control.) |
| HyperLabel |
The hyperlabel connected to the control.
(Inherited from Control.) |
| Image |
An image object representing the icon or bitmap image that is displayed on a button.
(Inherited from Button.) |
| IsHidden | (Inherited from Control.) |
| Length |
A numeric value representing the number of characters in the control.
(Inherited from TextControl.) |
| 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.) |
| 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.) |
| TextColor |
The color used to draw the text in the control. (Refer to the Color:Init() method for details on specifying a color object.)
(Inherited from TextControl.) |
| TextValue |
A string representing the value held in the control.
(Inherited from TextControl.) |
| 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 |
PushButton:Value always returns FALSE, since it has a single state.
(Overrides Value.) |
| ValueChanged | (Inherited from Control.) |
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.) |
| AsString |
Return an identifying label for the button.
(Inherited from Button.) |
| BringToFront | (Inherited from Control.) |
| Create |
Creates the underlying Win32 control
(Inherited from TextControl.) |
| 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 any TextControl.Destroy object.
(Inherited from TextControl.) |
| 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.) |
| 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.) |
| Font |
Change the current font of the text control.
(Inherited from TextControl.) |
| 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.) |
| Ime |
Return and optionally set whether Input Method Editor is enabled for this text control.
(Inherited from TextControl.) |
| 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.) |
| OnControlCreated | (Inherited from Control.) |
| OnHandleCreated | (Inherited from TextControl.) |
| OnHandleDestroyed | (Inherited from TextControl.) |
| 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.) |
| RegisterTimer |
Register a timer method to be invoked for the control.
(Inherited from Control.) |
| RemoveEditBalloonTip |
Removes the current BallonTip from the Edit control that has inherited from this class.
(Inherited from TextControl.) |
| 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.) |
| SetCueBanner(String) |
Add a cue banner to the Edit control that has inherited from this class.
(Inherited from TextControl.) |
| SetCueBanner(String, IntPtr) | (Inherited from TextControl.) |
| 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.) |
| SetStyle |
Set the style for the control.
(Inherited from Control.) |
| Show |
Display a control so it is visible.
(Inherited from Control.) |
| ShowEditBalloonTip |
Add a BallonTip to the Edit control that has inherited from this class.
(Inherited from TextControl.) |
| ShowToolTip | (Inherited from Control.) |
| 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.) |
Globals and Defines
Remarks
Unlike check boxes and radio buttons, which have an identifiable state, push buttons have no state; they are always ready to be clicked. However, you can specify one of the push buttons on a window to be the default button, in which case it can be activate by pressing the Enter key; the default push button is indicated by its heavy border.
In Windows, push buttons are the equivalent to a button with the BS_PUSHBUTTON style. The style BS_DEFPUSHBUTTON is also very useful because the button automatically gets focus in a dialog box.
In Windows, push buttons can be created in a resource entity as follows:
X#
1RESOURCE IDD_ABOUT DIALOG 20, 20, 160, 120 2STYLE WS_POPUP | WS_DLGFRAME 3BEGIN 4PUSHBUTTON "Cancel" IDB_CANCEL, 64, 50, 32, 14 5DEFPUSHBUTTON "OK" IDB_OK, 64, 80, 32, 14,; WS_GROUP 6END
See Also