checkboxNN 2   IE 3   DOM 1

The checkbox object is a form control generated with an INPUT element whose TYPE attribute is set to "checkbox".

 
HTML Equivalent
<INPUT TYPE="checkbox">
 
Object Model Reference
NN [window.]document.formName.elementName
[window.]document.forms[i].elements[i]
IE [window.]document.formName.elementName
[window.]document.forms[i].elements[i]
[window.]document.all.elementID
accessKeyNN n/a   IE 4   DOM 1
 Read/Write
 

A single character key that "clicks" on the checkbox. The browser and operating system determine whether the user must press a modifier key (e.g., Ctrl, Alt, or Command) with the access key to "click" the checkbox. In IE 4/Windows, the Alt key is required, and the key is not case sensitive. Not working in IE 4/Mac.

 
Example
document.entryForm.myCheckbox.accessKey = "n"
 
Value
Single alphanumeric (and punctuation) keyboard character.
 
Default None.
checkedNN 2   IE 3   DOM 1
 Read/Write
 

Whether the checkbox is selected or turned on by the user. Checkboxes operate independently of each other. Only checkbox objects with the checked property set to true have their name/value pair submitted with the form. To find out whether the form element is set to be checked when the page loads, see the defaultChecked property.

 
Example
if (document.choiceForm.monitors.checked) {
    process for the "monitors" checkbox being checked
}
 
Value
Boolean: true | false.
 
Default false
dataFldNN n/a   IE 4   DOM n/a
 Read/Write
 

Used with IE 4 data binding to associate a remote data source column name to a checkbox object's VALUE attribute. A DATASRC attribute must also be set for the element. Setting both the dataFld and dataSrc properties to empty strings breaks the binding between element and data source.

 
Example
document.myForm.myCheckbox.dataFld = "linkURL"
 
Value
Case-sensitive identifier of the data source column.
 
Default None.
dataSrcNN n/a   IE 4   DOM n/a
 Read/Write
 

Used with IE 4 data binding to specify the name of the remote ODBC data source (such as an Oracle or SQL Server database) to be associated with the element. Content from the data source is specified via the DATAFLD attribute. Setting both the dataFld and dataSrc properties to empty strings breaks the binding between element and data source.

 
Example
document.myForm.myCheckbox.dataSrc = "#DBSRC3"
 
Value
Case-sensitive identifier of the data source.
 
Default None.
defaultCheckedNN 2   IE 3   DOM 1
 Read/Write
 

Whether the element has the CHECKED attribute set in the tag. You can compare the current checked property against defaultChecked to see whether the state of the control has changed since the document loaded. Changing this property does not affect the current checked status.

 
Example
var cBox = document.forms[0].checkbox1
if (cBox.checked != cBox.defaultChecked) {
    process for changed state
}
 
Value
Boolean value: true | false.
 
Default Determined by HTML tag attribute.
disabledNN n/a   IE 4   DOM 1
 Read/Write
 

Whether the element is available for user interaction. When set to true, the element cannot receive focus or be modified by the user. It is also not submitted with the form.

 
Example
document.forms[0].myCheckbox.disabled = true
 
Value
Boolean value: true | false.
 
Default false
formNN 2   IE 3   DOM n/a
 Read-only
 

Returns a reference to the FORM element that contains the current element (if any). This property is most often passed as a parameter for an event handler, using the this keyword to refer to the current form control.

 
Example
<INPUT TYPE="button" VALUE="Validate Form" onClick="doValidate(this.form)">
 
Value
Object reference.
 
Default None.
indeterminateNN n/a   IE 4   DOM n/a
 Read/Write
 

Whether a checkbox is visually represented as being neither checked nor unchecked, yet still active. This middle ground is rendered differently for different operating systems. In Windows, the checkbox is grayed out (with the checkmark still visible if it was there originally) but still active. On the Macintosh, the checkbox displays a hyphen inside the box. The indeterminate state usually means some change elsewhere on the page has likely affected the setting of the checkbox, requiring the user to verify the checkbox's setting for accuracy.

 
Example
document.orderForm.2DayAir.indeterminate = true
 
Value
Boolean value: true | false.
 
Default false
nameNN 2   IE 3   DOM 1
 Read/Write
 

The identifier associated with the form control. The value of this property is submitted as one-half of the name/value pair when the form is submitted to the server. Names are hidden from user view, since control labels are assigned via other means, depending on the control type. Form control names may also be used by script references to the objects.

 
Example
document.orderForm.myCheckbox.name = "Win32"
 
Value
Case-sensitive identifier that follows the rules of identifier naming: it may contain no whitespace, cannot begin with a numeral, and should avoid punctuation except for the underscore character.
 
Default None.
recordNumberNN n/a   IE 4   DOM n/a
 Read-only
 

Used with data binding, returns an integer representing the record within the data set that generated the element (i.e., an element whose content is filled via data binding). Values of this property can be used to extract a specific record from an Active Data Objects (ADO) record set (see recordset property).

 
Example
<SCRIPT FOR="tableTemplate" EVENT="onclick">
    myDataCollection.recordset.absoluteposition = this.recordNumber
    ...
</SCRIPT>
 
Value
Integer.
 
Default None.
statusNN n/a   IE 4   DOM n/a
 Read/Write
 

Whether the element is highlighted/checked. This property is identical to the value property.

 
Example
if (document.forms[0].56KbpsBox.status) {
    ...
}
 
Value
Boolean value: true | false.
 
Default None.
tabIndexNN n/a   IE 4   DOM 1
 Read/Write
 

A number that indicates the sequence of this element within the tabbing order of all focusable elements in the document. Tabbing order follows a strict set of rules. Elements that have values other than zero assigned to their tabIndex properties are first in line when a user starts tabbing in a page. Focus starts with the element with the lowest tabIndex value and proceeds in order to the highest value, regardless of physical location on the page or in the document. If two elements have the same tabIndex values, the element that comes earlier in the document receives focus first. Next come all elements that either don't support the tabIndex property or have the value set to zero. These elements receive focus in the order in which they appear in the document. A value of -1 removes the element from tabbing order altogether.

Note that the Macintosh user interface does not provide for giving focus to elements other than text and password INPUT fields.

 
Example
document.forms[0].ZIP.tabIndex = 6
 
Value
Integer.
 
Default None.
typeNN 3   IE 4   DOM 1
 Read-only
 

Returns the type of form control element. The value is returned in all lowercase letters. It may be necessary to cycle through all form elements in search of specific types to do some processing on (e.g., emptying all form controls of type "text" while leaving other controls untouched).

 
Example
if (document.forms[0].elements[3].type ==  "checkbox") {
    ...
}
 
Value
Any of the following constants (as a string): button | checkbox | file | hidden | image | password | radio | reset | select-multiple | select-one | submit | text | textarea.
 
Default checkbox
valueNN 2   IE 3   DOM 1
 Read/Write
 

Current value associated with the form control that is submitted with the name/value pair for the element (if the checkbox is checked). All values are strings, but they may represent other kinds of data, including Boolean and numeric values.

 
Example
document.forms[0].myBox.value = "*"
 
Value
String.
 
Default None.
blur( )NN n/a   IE 4   DOM n/a

Removes focus from the current element and fires an onBlur event (in IE). No other element necessarily receives focus as a result.

 
Returned Value
None.
 
Parameters
None.
focus( )NN n/a   IE 4   DOM n/a

Gives focus to the current element and fires the onFocus event (in IE). If another element had focus at the time, it receives an onBlur event.

 
Returned Value
None.
 
Parameters
None.
handleEvent( )NN 4   IE n/a   DOM n/a

handleEvent(event)

Instructs the object to accept and process the event whose specifications are passed as the parameter to the method. The object must have an event handler for the event type to process the event.

 
Returned Value
None.
 
Parameters
event A Navigator 4 event object.