Click or drag to resize

RadioButtonGroup Class

X#
A group of radio buttons considered as a combination control, presenting a set of options and returning a single value.
Inheritance Hierarchy
Object
  VObject
    Control
      TextControl
        GroupBox
          RadioButtonGroup

Namespace:  VO
Assembly:  VOGUIClasses (in VOGUIClasses.dll) Version: 2.19
Syntax
 CLASS RadioButtonGroup INHERIT GroupBox
Request Example View Source

The RadioButtonGroup type exposes the following members.

Constructors
  NameDescription
Public methodRadioButtonGroup
Construct a radio button group.
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 propertyCaption
The string representing the caption of the text control.
(Inherited from TextControl.)
Public propertyContextMenu
A menu object representing the local pop-up menu for a control.
(Inherited from Control.)
Public propertyControlFont
The font used to draw the text in the control.
(Inherited from TextControl.)
Public propertyControlID
A number between 1 and 8000 representing the unique ID of a control
(Inherited from Control.)
Public propertyCurrentText
This property is provided to override the inherited functionality from the TextControl class, as it does not apply to group boxes.
(Inherited from GroupBox.)
Public propertyFieldSpec
The field specification connected to the control.
(Inherited from Control.)
Public propertyHyperLabel
The hyperlabel connected to the control.
(Inherited from Control.)
Public propertyLength
A numeric value representing the number of characters in the control.
(Inherited from TextControl.)
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 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 propertyTextColor
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.)
Public propertyTextValue
RadioButtonGroup:TextValue holds the first element of the FillUsing() array
(Overrides TextValue.)
Public propertyToolTipText
String value representing the tooltip text used when the user moves the mouse pointer over the control.
(Inherited from Control.)
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 propertyValue
Contains the group value setting (specified on the Window Editor Property Window) associated with the radio button within the group that is selected.
(Overrides Value.)
Public propertyValueChanged
A logical value representing whether the control's Value has been changed from its prior setting.
(Inherited from Control.)
Top
Methods
  NameDescription
Public methodActivate
Provide a method that is invoked when the control has focus and a window is activated.

(Inherited from Control.)
Public methodAsString
Return an identifying label for the group box.
(Inherited from GroupBox.)
Public methodButton
Retrieve a specific radio button.
Public methodCreate
Creates the underlying Win32 control
(Inherited from TextControl.)
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 TextControl.Destroy object.
(Inherited from TextControl.)
Public methodDisable
Disable a radio button group (until a subsequent call to RadioButtonGroup:Enable()).
(Overrides Disable.)
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 methodEnable
Enable a radio button group that was previously disabled.
(Overrides Enable.)
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 methodCode exampleFillUsing
Specify the radio buttons that make up the group and the set of values corresponding to these buttons, using an array.
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 methodFont
Change the current font of the text control.
(Inherited from TextControl.)
Public methodGetExStyle
Retrieve the Ex styles for the control.
(Inherited from Control.)
Public methodGetStyle
Retrieve the styles for the control.
(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 radio button group so it is not visible (until a subsequent call to RadioButtonGroup:Show()).
(Overrides Hide.)
Public methodHorizontalScroll
Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled.

(Inherited from Control.)
Public methodIme
Return and optionally set whether Input Method Editor is enabled for this text control.
(Inherited from TextControl.)
Public methodIsEnabled
Report if this control is currently enabled.
(Inherited from Control.)
Public methodIsExStyle
Check if a exstyle value has been set for the control
(Inherited from Control.)
Public methodIsReadOnly
Report if this control is currently readonly.
(Inherited from Control.)
Public methodIsStyle
Check if a style value has been set for the control
(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 methodOverRide
This is a compatibility method that is no longer used or needed.
(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 methodRemoveEditBalloonTip
Removes the current BallonTip from the Edit control that has inherited from this class.
(Inherited from TextControl.)
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 methodSetCueBanner
Add a cue banner to the Edit control that has inherited from this class.
(Inherited from TextControl.)
Public methodSetExStyle
Set the exstyle for the control.
(Inherited from Control.)
Public methodSetFocus
Pass input focus to the selected radio button within the radio button group.
(Overrides SetFocus.)
Public methodSetParent
Change the parent handle for the control.
(Inherited from Control.)
Public methodSetStyle
Set the style for the control.
(Inherited from Control.)
Public methodShow
Display a radio button group so it is visible.
(Overrides Show.)
Public methodShowEditBalloonTip
Add a BallonTip to the Edit control that has inherited from this class.
(Inherited from TextControl.)
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
Fields
  NameDescription
Public fieldEventReturnValue (Inherited from Control.)
Public fieldoCargo
Cargo slot.
(Inherited from VObject.)
Top
Remarks
Radio buttons are commonly used to allow selection of one among a specific list of options. However, treating several radio buttons as individual controls requires explicit management of the behavior of the buttons: when one is selected, the program must turn off the other buttons in the group. Individual radio buttons are also not suited for linking to a database: databases typically do not have several fields representing linked properties, but rather a single field that can take on different values. The radio button group is a higher level control that automatically handles the interlinking of the buttons. It also links to database fields in a more intelligent way than individual radio buttons: the group as a whole is considered as one control that takes one of a number of specific values. Since the radio button group is the control that you deal with, and its constituent radio buttons are not directly referenced by the program, properties such as the hyperlabel, field specification, caption, value, and text value are attached to the group. The value is either the number of the radio button which is currently selected in the sequence or one of the values specified for a radio button in a two-dimensional array through FillUsing(). The text value is the same value formatted according to the picture clause of the field specification attached to the group (to get the caption displayed next to the radio buttons, retrieve the selected button and reference its caption property. Note that the data type and picture of the group's field specification are used and the field specs of the individual radio buttons are ignored. The radio button group behaves similarly to a list box or combo box and may be used as an alternative to any constrained single-selection list box when the number of options is small and fixed. (Although the radio button group supports variable caption strings for the individual buttons, a list box is usually a better choice for very dynamic data.) A radio button group is created empty and radio buttons are associated with it through the FillUsing() method. If you create a radio button using the Window Editor, the FillUsing( ) method in the generated source code defines a two-dimensional array, with one row for each button. The first element contains the caption of the radio button and the second element contains its group value. When a button is pressed, the radio button group's TextValue contains the first element (the button caption), and Value contains the second element (the group value). If no button is pressed, RadioButtonGroup:TextValue is NULL_STRING and RadioButtonGroup:Value is NIL. A radio button group may be bound to a field in a server. The field's data value is stored in RadioButtonGroup:Value. The radio button group compares the field's data value to the second element values specified in the FillUsing() array, and if a match is found, the first element (the button caption) is stored in RadioButtonGroup:TextValue. If there is no match, RadioButtonGroup:TextValue is NULL_STRING. If a button is pressed, the corresponding second element is stored as RadioButtonGroup:Value, and this value is written to the server.
See Also

Reference