CodeCharge Studio

All ASP PHP Perl ColdFusion Java C#.NET VB.NET

Radio Button Reference

Design-Time Properties

Property	Description
Name	Name of the control.
Caption	Name used to refer to the control in an error message.
Control Source Type	Type of data source that will provide data for the control: Database Column, Code Expression.
Control Source	Specify the source of data for the control e.g. the name of a database column.
Connection	The database connection from where information will be retrieved.
Data Source Type	Specify the type of source of data for the list of values to be shown in the control e.g. the name of a database column.
Data Source	Specify the actual source of data for the list of values depending on the List Source Type.
Bound Column	The data source column containing the values that will be submitted.
Text Column	The data source column containing the values that will be displayed.
Data Type	The type of data that will be contained in the control.
Default Value	Specify a default value to be used for the control if no value is otherwise specified.
Content	The type of the content [Text or HTML].
Required	[Yes/No] Select 'Yes' if a value must be entered for the control in order for the form to be submitted successfully.
Unique	Yes/No] Select 'Yes' if you want a check to be made to ensure that any value entered in the control does not already exist in the database.
Error Control	Specify the name of a control that will be used to display any error messages pertaining to the control. If this value is not specified, all error messages are displayed at the top of the form in which the control is contained..
Validation Rule	Specify an expression that will be used to check the validity of the data entered in the control.
Validation Text	Specify the text that will be displayed if the data entered in the control does not meet the validation rule.

Events

Event	Description
Server Side Events
On Validate	Occurs after the control value have been submitted to the server and before the submitted value is used to update any database content. This event is meant to be used to specify any validation operations that should be run against the submitted value to ensure that the value is valid. The addErrors method of the form can be used to log an error if the validation check fails.
Before Show	Occurs before the control is rendered to the page. This event can be used to set template variables placed within the control's HTML block. For instance, the control can be disabled conditionally.
Before Build Select	Occurs before the query used to retrieve the data for the control is built. This event can be used to modify the data retrieval query e.g. set the value of the where or order by clause.
Before Execute Select	Occurs before the query used to retrieve the data for the control is executed. This event can be used to modify the entire query before it is executed.
After Execute Select	Occurs after the query used to retrieve the data for the control has been executed and the results of the query have been returrned in a recordset.
Client Side Events
On Click	Occurs immediately after the control has been clicked. This event can be used to provide interactive behavior when the control is clicked.

Run-Time Properties (ASP)

Property	Description
DataSource	This property stores a reference to the data source bound to the radio button. The data source handles all data retrieval operations.
Errors	An object that contains the error messages generated during script execution when submitted data fails verification or any other user defined condition is not fulfilled.
Recordset	This property contains a recordset with the data retrieved for the control.
Value	This property contains the value of the selected radio button.
Visible	This property determines whether the component is to be shown or not. Components can only be hidden if they have Extended HTML generated. To hide the component this property has to be set to false in some parent component's Before Show event.

Data Source properties

Property	Description
DataSource.SQL	This property contains SQL query used to retrieve records displayed with grid form.
DataSource.Where	This property contains portion of SQL query containing expressions used to filter the grid rows (WHERE clause).

Run-Time Properties (PHP)

Property	Description
ComponentType	Specifies type of an object, such as "TextBox", "Record", etc.
Parent	Specifies parent container of an object, for example a record form for a textbox that is included within that form.
DataSource	This property stores a reference to the data source bound to the radio button. The data source handles all data retrieval operations.
Errors	An object that contains the error messages generated during script execution when submitted data fails verification or any other user defined condition is not fulfilled.
Visible	This property determines whether the component is to be shown or not. Components can only be hidden if they have Extended HTML generated. To hide the component this property has to be set to false in some parent component's Before Show event.

Data Source properties

Property	Description
DataSource->SQL	This property contains SQL query used to retrieve records displayed with grid form.
DataSource->Where	This property contains portion of SQL query containing expressions used to filter the grid rows (WHERE clause).

Methods (PHP)

Method	Description
GetValue	Returns the value of the selected radio button.
SetValue	Sets the selected radio button based on its value.

Run-Time Properties (.NET)

Interface System.Web.UI.WebControls.RadioButtonList class is used.

Property	Description
Items	Gets the collection of items in the list control. See .NET Framework SDK reference.
SelectedIndex	Gets or sets the lowest ordinal index of the selected items in the list. See .NET Framework SDK reference.
SelectedItem	Gets the selected item with the lowest index in the list control. See .NET Framework SDK reference.
Visible	This property determines whether the control is visible (parsed into template) or not.

Model Layer

Property	Description
<control name>	Contains current value of control.
<control name>Items	Collection of control items.

Run-Time Variables (CF,CFT)

Variable	Description
arr_<owner name><control name>	This variable contains the array of items in the list control.
fld<control name>	Holds a value of the control.
hide<control name>	This variable controls the visibility of the control. If the variable is set to true, the control will not be displayed.
strOrder<control name>	This variable contains the ORDER clause to be used with the SQL query to execute for a query object (cfquery tag).
strSQL<control name>	This variable contains the SQL query to execute for a query object (cfquery tag) for gets data.
strWhere<control name>	This variable contains the WHERE clause to be used with the SQL query to execute for a query object (cfquery tag).
query<control name>	This variable contains query object.

Methods (Servlets & JSP)

Method	Description
addValue	For Multiselect lists add value to selected values list.
setValues	Set list selected values from Enumeration of Strings.
setListOfValues	Set list of values to choose from. Used to populate list values from String.
getOptions	Get Options list in form of Enumeration of Strings.
setOptions	Set list of values to choose from. Used to populate list values from String.
getFormattedOptions	Prepare list collection for output. This method marks those list values that were selected by request.
getPage	Get the page that contains this control.
getFormattedValue	Get the value formatted according to the control format.
setFormattedValue	Set the control value from String. Value is taken as is, formatting will not be applied to this value.
hasErrors	Whether the control has (validation) errors.
addError	Add error description to errors collection.
getErrorsAsString	Get all errors formatted as String, separated by <br> elements.
isVisible	Returns a value indicating whether this control should be displayed or not.
setVisible	Specify whether this control or component should be shown.
getParent	Get the parent component that contains this control or component.

See also

Radio Button Overview

On-line, printable versions and updates