Visual InterDev

setChecked Method

See Also      Applies To

Sets the state of the Checkbox object.

Syntax

object.setChecked(value)

Parameters

Object

A Checkbox script object.

value

The value that is written to the database.

Remarks

The Checkbox object is often used for displaying and writing Boolean data to a database. However, it is not necessary to use data binding.

When data binding, the state of the Checkbox is mapped to the <INPUT> tag's VALUE attribute. The value that is written to the database upon submission of the form depends on the data type of the Recordset object's data field and the user's input.

You can pass a number of different types of arguments to set a Checkbox.

• "0", 0, false, and "false" all set the Checkbox to unchecked.
  
  
• "1", 1, true, "true", true, or any number that is not 0 as either a number or a string, all set it to checked.

To get the state of the Checkbox, see the getChecked method.

Example

function btnCheck_onclick() 
{
   // Toggle the checked state of the checkbox when the user clicks btnCheck
   if (Checkbox1.getChecked() )
      Checkbox1.setChecked( 0 );      // param can be a number
   else
      Checkbox1.setChecked( "true" );    // or a string, or Boolean 
}