RadioButton control

A RadioButton is a small round button that is used to turn an option on and off. When the option is on, the button has a dark center. When the option is off, the center is blank.

In a GroupBox

RadioButtons are often grouped in a GroupBox. In this case, the user can select only one button in the group, and the group usually has a default button.

Properties

RadioButton property

Datatype

Description

AccessibleDescription

String

A description of the control and/or its purpose for use by accessibility tools such as readers for visually impaired users.

AccessibleName

String

A label that briefly describes the control, such as the text in a button or the name of a menu item.

AccessibleRole

AccessibleRole (enumerated)

Describes what kind of user interface element the control is.

Automatic

Boolean

Specifies whether the control becomes dark when it is clicked. Values are:

TRUE -- Control becomes dark when clicked.

FALSE -- Control does not become dark when clicked.

BackColor

Long

Specifies the numeric value of the background color: -2 to 16,777,215. For more information about color, see the section called “RGB” in PowerScript Reference.

BorderStyle

BorderStyle (enumerated)

Specifies the style of the border of the control. Values are:

StyleLowered!

StyleRaised!

BringToTop

Boolean

Specifies whether PowerBuilder moves the control to the top of the front-to-back order in the window. Values are:

TRUE -- Control moved to top.

FALSE -- Control not moved to top.

Checked

Boolean

Specifies whether the item is selected (the center is dark). Values are:

TRUE -- Control is selected.

FALSE -- Control is not selected.

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

DragAuto

Boolean

Specifies whether PowerBuilder puts the control automatically into Drag mode. Values are:

TRUE  -- When the control is clicked, the control is automatically in Drag mode.

FALSE  -- When the control is clicked, the control is not automatically in Drag mode. You have to manually put the control into Drag mode by using the Drag function.

DragIcon

String

Specifies the name of the stock icon or the file containing the icon you want to display when the user drags the control (the ICO file). The default icon is a box the size of the control.

When the user drags the control, the icon displays when the control is over an area in which the control can be dropped (a valid drop area). When the control is over an area that is not a valid drop area, the No-Drop icon displays.

Enabled

Boolean

Specifies whether the control is enabled (can be selected). Values are:

TRUE -- Control is enabled.

FALSE -- Control is not enabled.

FaceName

String

Specifies the name of the typeface in which the text of the control displays (for example, Helv or Courier).

FontCharSet

FontCharSet (enumerated)

Specifies the font character set used for the text in the control. For a complete list of possible values, see the list of properties for the FontCharSet variable on the Enumerated tab page of the Browser.

FontFamily

FontFamily (enumerated)

Specifies the font family (type style) used for the text in the control. Values are:

AnyFont!

Decorative!

Modern!

Roman!

Script!

Swiss!

FontPitch

FontPitch (enumerated)

Specifies the pitch (spacing) of the font used for the text in the control. Values are:

Default!

Fixed!

Variable!

Height

Integer

Specifies the height of the control, in PowerBuilder units.

Italic

Boolean

Specifies whether the text in the control is italic. Values are:

TRUE -- Text is italic.

FALSE -- Text is not italic.

LeftText

Boolean

Specifies whether the text displays to the left of the control. Values are:

TRUE -- Text displays to the left.

FALSE -- Text does not display to the left.

Pointer

String

Specifies the name of the stock pointer or the file containing the pointer used for the control.

RightToLeft

Boolean

Specifies that characters should be displayed in right-to-left order. The application must be running on an operating system that supports right-to-left display. Values are:

TRUE -- Characters display in right-to-left order.

FALSE -- Characters display in left-to-right order.

TabOrder

Integer

Specifies the tab value of the control (0 means the user cannot tab to the control). In a GroupBox, the up and down arrow keys are used to move among RadioButtons in a specified sequence.

To permit tabbing in a GroupBox, change the tab value of the GroupBox to 0 and assign nonzero tab values to the RadioButtons (the default tab value for the RadioButtons in a GroupBox is 0).

Tag

String

Specifies the tag value assigned to the control.

Text

String

Specifies the text that displays next to the control.

TextColor

Long

Specifies the numeric value of the color used for text: -2 to 16,777,215. For more information about color, see the section called “RGB” in PowerScript Reference.

TextSize

Integer

Specifies the size of the text in the control, in points. For backward compatibility, the size is stored as a negative number; for example, 10-point text size is stored as -10.

Underline

Boolean

Specifies whether the text in the control is underlined. Values are:

TRUE -- Text is underlined.

FALSE -- Text is not underlined.

Visible

Boolean

Specifies whether the control is visible. Values are:

TRUE -- Control is visible.

FALSE -- Control is not visible.

Weight

Integer

Specifies the stroke weight of the text in the control; for example, 400 for normal or 700 for bold.

Width

Integer

Specifies the width of the control, in PowerBuilder units.

X

Integer

Specifies the X position (the distance from the left edge of the window), in PowerBuilder units.

Y

Integer

Specifies the Y position (the distance from the top of the window), in PowerBuilder units.


Events

RadioButton event

Occurs

Clicked in PowerScript Reference

When the control is clicked (selected or unselected)

Constructor in PowerScript Reference

Immediately before the Open event occurs in the window

Destructor in PowerScript Reference

Immediately after the Close event occurs in the window

DragDrop in PowerScript Reference

When a dragged control is dropped on the control

DragEnter in PowerScript Reference

When a dragged control enters the control

DragLeave in PowerScript Reference

When a dragged control leaves the control

DragWithin in PowerScript Reference

When a dragged control is within the control

GetFocus in PowerScript Reference

Just before the control receives focus (before it is selected and becomes active)

Help in PowerScript Reference

When the user presses the F1 key or drags the context help button (question mark) from the title bar to a menu item or control

LoseFocus in PowerScript Reference

When the control loses focus (becomes inactive)

Other in PowerScript Reference

When a Windows message occurs that is not a PowerBuilder event

RButtonDown in PowerScript Reference

When the right mouse button is pressed on the control


Functions

RadioButton function

Datatype returned

Description

ClassName in PowerScript Reference

String

Returns the name assigned to the control

Drag in PowerScript Reference

Integer

Starts or ends the dragging of the control

GetContextService in PowerScript Reference

Integer

Creates a reference to a context-specific instance of the specified service

GetParent in PowerScript Reference

PowerObject

Returns a reference to the name of the parent object

Hide in PowerScript Reference

Integer

Makes the control invisible

Move in PowerScript Reference

Integer

Moves the control to a specified location

PointerX in PowerScript Reference

Integer

Returns the distance of the pointer from the left edge of the control

PointerY in PowerScript Reference

Integer

Returns the distance of the pointer from the top of the control

PostEvent in PowerScript Reference

Boolean

Adds an event to the end of the message queue for control

Print in PowerScript Reference

Integer

Prints the control

Resize in PowerScript Reference

Integer

Changes the size of the control

SetFocus in PowerScript Reference

Integer

Sets focus to the control

SetPosition in PowerScript Reference

Integer

Specifies the position of the control in the front-to-back order of the window

SetRedraw in PowerScript Reference

Integer

Controls automatic redrawing of the control after each change in its properties

Show in PowerScript Reference

Integer

Makes the control visible

TriggerEvent in PowerScript Reference

Integer

Triggers a specified event for the control and executes the script for the event

TypeOf in PowerScript Reference

Object

Returns the type of the control