input type=checkbox element | input type=checkbox object (Windows)

This topic has not yet been rated - Rate this topic

Creates a check box control.

HTML information

Closing Tag	forbidden
CSS Display	inline

DOM Information

Inheritance Hierarchy

Node

Element

HTMLElement

input type=checkbox

Members

The input type=checkbox object has these types of members:

Events
Methods
Properties

Events

The input type=checkbox object has these events.

Event	Description
abort	Fires when the user aborts the download.
activate	Fires when the object is set as the active element.
beforeactivate	Fires immediately before the object is set as the active element.
blur	Fires when the object loses the input focus.
change	Fires when the contents of the object or selection have changed.
click	Fires when the user clicks the left mouse button on the object.
contextmenu	Fires when the user clicks the right mouse button in the client area, opening the context menu.
dblclick	Fires when the user double-clicks the object.
deactivate	Fires when the activeElement is changed from the current object to another object in the parent document.
drag	Fires on the source object continuously during a drag operation.
dragend	Fires on the source object when the user releases the mouse at the close of a drag operation.
dragenter	Fires on the target element when the user drags the object to a valid drop target.
dragleave	Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
dragover	Fires on the target element continuously while the user drags the object over a valid drop target.
dragstart	Fires on the source object when the user starts to drag a text selection or selected object.
drop	Fires on the target object when the mouse button is released during a drag-and-drop operation.
error	Fires when an error occurs during object loading.
focus	Fires when the object receives focus.
focusin	Fires for an element just prior to setting focus on that element.
focusout	Fires for the current element with focus immediately after moving focus to another element.
input	Occurs when the text content of an element is changed through the user interface.
keydown	Fires when the user presses a key.
keypress	Fires when the user presses an alphanumeric key.
load	Fires immediately after the client loads the object.
mousedown	Fires when the user clicks the object with either mouse button.
mouseenter	Fires when the user moves the mouse pointer into the object.
mouseleave	Fires when the user moves the mouse pointer outside the boundaries of the object.
mousemove	Fires when the user moves the mouse over the object.
mouseout	Fires when the user moves the mouse pointer outside the boundaries of the object.
mouseover	Fires when the user moves the mouse pointer into the object.
mouseup	Fires when the user releases a mouse button while the mouse is over the object.
onbeforedeactivate	Fires immediately before the activeElement is changed from the current object to another object in the parent document.
onkeyup	Fires when the user releases a key.
onselect	Fires when the current selection changes.
readystatechange	Fires when the state of the object has changed.
reset	Fires when the user resets a form.
resize	Fires when the size of the object is about to change.
scroll	Fires when the user repositions the scroll box in the scroll bar on the object.

Methods

The input type=checkbox object has these methods.

Method	Description
appendChild	Appends an element as a child to the object.
applyElement	Makes the element either a child or parent of another element.
blur	Causes the element to lose focus and fires the onblur event.
clearAttributes	Removes all attributes and values from the object.
click	Simulates a click by causing the onclick event to fire.
cloneNode	Copies a reference to the object from the document hierarchy.
compareDocumentPosition	Compares the position of two nodes in a document.
componentFromPoint	Returns the component located at the specified coordinates via certain events.
contains	Checks whether the given element is contained within the object.
doScroll	Simulates a click on a scroll bar component.
dragDrop	Initiates a drag event.
focus	Causes the element to receive the focus and executes the code specified by the onfocus event.
getAdjacentText	Returns the adjacent text string.
getAttribute	Retrieves the value of the specified attribute.
getAttributeNode	Retrieves an attribute object referenced by the attribute.name property.
getAttributeNodeNS	Gets an attribute object that matches the specified namespace and name.
getAttributeNS	Gets the value of the specified attribute within the specified namespace.
getBoundingClientRect	Retrieves an object that specifies the bounds of a collection of TextRectangle objects.
getClientRects	Retrieves a collection of rectangles that describes the layout of the contents of an object or range within the client. Each rectangle describes a single line.
getElementsByClassName	Gets a collection of objects that are based on the value of the class attribute.
getElementsByTagNameNS	Gets a collection of objects that are based on the specified element names within a specified namespace.
hasAttribute	Determines whether an attribute with the specified name exists.
hasAttributeNS	Determines whether an attribute that has the specified namespace and name exists.
hasAttributes	Determines whether one or more attributes exist for the object.
hasChildNodes	Returns a value that indicates whether the object has children.
insertAdjacentElement	Inserts an element at the specified location.
insertAdjacentHTML	Inserts the given HTML text into the element at the location.
insertAdjacentText	Inserts the given text into the element at the specified location.
insertBefore	Inserts an element into the document hierarchy as a child node of a parent object.
isDefaultNamespace	Indicates whether or not a namespace is the default namespace for a document.
isEqualNode	Determines if two nodes are equal.
isSameNode	Determines if two node references refer to the same node.
isSupported	Returns a value indicating whether or not the object supports a specific DOM standard.
lookupNamespaceURI	Gets the URI of the namespace associated with a namespace prefix, if any.
lookupPrefix	Gets the namespace prefix associated with a URI, if any.
mergeAttributes	Copies all read/write attributes to the specified element.
msMatchesSelector	Determines whether an object matches the specified selector.
normalize	Merges adjacent DOM objects to produce a normalized document object model.
querySelector	Retrieves the first DOM element node from descendants of the starting element node that match any selector within the supplied selector string.
querySelectorAll	Retrieves all DOM element nodes from descendants of the starting element node that match any selector within the supplied selector strings.
releaseCapture	Removes mouse capture from the object in the current document.
removeAttribute	Removes an attribute from an object.
removeAttributeNode	Removes an attribute object from the object.
removeAttributeNS	Removes the specified attribute from the object.
removeChild	Removes a child node from the object.
removeNode	Removes the object from the document hierarchy.
replaceAdjacentText	Replaces the text adjacent to the element.
replaceChild	Replaces an existing child element with a new child element.
replaceNode	Replaces the object with another element.
scrollIntoView	Causes the object to scroll into view, aligning it either at the top or bottom of the window.
select	Highlights the input area of a form element.
setActive	Sets the object as active without setting focus to the object.
setAttribute	Sets the value of the specified attribute.
setAttributeNode	Sets an attribute object node as part of the object.
setAttributeNodeNS	Sets an attribute object as part of the object.
setAttributeNS	Sets the value of the specified attribute within the specified namespace.
setCapture	Sets the mouse capture to the object that belongs to the current document.
swapNode	Exchanges the location of two objects in the document hierarchy.

Properties

The input type=checkbox object has these properties.

Property	Description
accessKey	Sets or retrieves the access key for the object.
ATOMICSELECTION	Specifies whether the element and its contents must be selected as a whole, indivisible unit.
attributes	Retrieves a collection of attributes of the object.
canHaveChildren	Gets a value indicating whether the object can contain child objects.
canHaveHTML	Retrieves the value indicating whether the object can contain rich HTML markup.
checked	Sets or retrieves the state of the check box or radio button.
childElementCount	Retrieves the number of immediate child nodes of the current element or a zero if the element does not contain any child nodes. childElementCount does not return all child nodes, only child nodes that are nodeType =1, or element nodes.
className	Sets or retrieves the class of the object.
clientHeight	Retrieves the height of the object including padding, but not including margin, border, or scroll bar.
clientLeft	Retrieves the distance between the offsetLeft property and the true left side of the client area.
clientTop	Retrieves the distance between the offsetTop property and the true top of the client area.
clientWidth	Retrieves the width of the object including padding, but not including margin, border, or scroll bar.
dataFld	Sets or retrieves a field of a given data source, as specified by the dataSrc property, to bind to the specified object.
dataSrc	Sets or retrieves the source of the data for data binding.
defaultChecked	Sets or retrieves the state of the check box or radio button.
defaultValue	Sets or retrieves the initial contents of the object.
dir	Sets or retrieves the reading order of the object.
disabled	Sets or retrieves a value that indicates whether the user can interact with the object.
firstChild	Gets a reference to the first child in the childNodes collection of the object.
firstElementChild	Retrieves a reference to the first child element, or NULL if there are no child elements.
form	Retrieves a reference to the form that the object is embedded in.
hideFocus	Sets or gets the value that indicates whether the object visibly shows that it has focus.
id	Sets or retrieves the string identifying the object.
indeterminate	Sets or retrieves whether the user has changed the status of a input type=checkbox element. On a HTMLProgressElement element will show activity but not a specific amount.
innerHTML	Sets or retrieves the HTML between the start and end tags of the object.
innerText	Sets or retrieves the text between the start and end tags of the object.
isContentEditable	Gets the value that indicates whether the user can edit the contents of the object.
isDisabled	Gets the value that indicates whether the user can interact with the object.
isMultiLine	Retrieves the value indicating whether the content of the object contains one or more lines.
isTextEdit	Retrieves whether a TextRange object can be created using the object.
lang	Sets or retrieves the language to use.
lastChild	Gets a reference to the last child in the childNodes collection of an object.
lastElementChild	Retrieves a reference to the last child element or NULL if there are no child elements.
localName	Retrieves the local name of the fully qualified XML declaration for a node.
name	Sets or retrieves the name of the object.
namespaceURI	Retrieves the namespace URI of the fully qualified XML declaration for a node.
nextElementSibling	Retrieves a reference to the sibling element that immediately follows or NULL if the element does not have any sibling elements that follow it.
nextSibling	Retrieves a reference to the next child of the parent for the object.
nodeName	Gets the name of a particular type of node.
nodeType	Retrieves the type of the requested node.
nodeValue	Gets or sets the value of a node.
offsetHeight	Retrieves the height of the object relative to the layout or coordinate parent, as specified by the offsetParent property.
offsetLeft	Retrieves the calculated left position of the object relative to the layout or coordinate parent, as specified by the offsetParent property.
offsetParent	Retrieves a reference to the container object that defines the offsetTop and offsetLeft properties of the object.
offsetTop	Retrieves the calculated top position of the object relative to the layout or coordinate parent, as specified by the offsetParent property.
offsetWidth	Retrieves the width of the object relative to the layout or coordinate parent, as specified by the offsetParent property.
outerHTML	Sets or retrieves the object and its content in HTML.
outerText	Sets or retrieves the text of the object.
ownerDocument	Retrieves the document object associated with the node.
parentElement	Retrieves the parent object in the object hierarchy.
parentNode	Retrieves the parent object in the document hierarchy.
parentTextEdit	Retrieves the container object in the document hierarchy that can be used to create a TextRange containing the original object.
prefix	Retrieves the local name of the fully qualified XML declaration for a node.
previousElementSibling	Retrieves a reference to the immediately preceding sibling element or NULL if the element does not have any preceding siblings.
previousSibling	Gets a reference to the previous child of the parent for the object.
readyState	Retrieves a value that indicates the current state of the object.
role	Sets or retrieves the role for this element.
scrollHeight	Retrieves the scrolling height of the object.
scrollLeft	Sets or retrieves the distance between the left edge of the object and the leftmost portion of the content currently visible in the window.
scrollTop	Sets or retrieves the distance between the top of the object and the topmost portion of the content currently visible in the window.
scrollWidth	Retrieves the scrolling width of the object.
sourceIndex	Retrieves the ordinal position of the object, in source order, as the object appears in the document's all collection.
STYLE	Sets an inline style for the element.
tabIndex	Sets or retrieves the index that defines the tab order for the object.
tagName	Retrieves the tag name of the object.
textContent	Sets or retrieves the text content of an object and any child objects.
title	Sets or retrieves advisory information (a ToolTip) for the object.
type	Retrieves or initially sets the type of input control represented by the object.
uniqueID	Retrieves an autogenerated, unique identifier for the object.
uniqueNumber	Retrieves the element's unique number.
value	Sets or retrieves the displayed value for the control object. This value is returned to the server when the control object is submitted.

Standards information

HTML 4.01 Specification, Section 17.4

Remarks

When an input type=checkbox element is selected, a name/value pair is submitted with the form. The default value of input type=checkbox is on.

The height and width styles are exposed to the input type=checkbox element. The size of the element is set based on the values provided by the author, subject to a particular minimum. The size is calculated as follows:

If the height or width is greater than 20 pixels, the padding around the check box is set to 4 pixels, and the inner height or width is set to 8 pixels.
If the height or width is less than 20 pixels but greater than 13 pixels, the padding around the check box is equal to one half the specified height or width minus 13. For example, if the specified width of the check box is 17, the equation would be: (17-13)/2.
If the height or width is less than 12 pixels, the padding around the check box is set to 0 and the inner width is set to the value specified by the author.

Note For code samples, see Form controls part 1 and Form controls part 2: validation on the a Windows Store app using JavaScript sample site.

In a Windows Store app using JavaScript, inserting an input type=checkbox object into the Document Object Model (DOM) tree does not reset the defaultChecked property. For more information, see Defining Document Compatibility.

Touching the label associated with a checkbox has the same effect as touching the checkbox directly.

Examples

This example uses the label tag to include the text with the checkbox to increase the touch sensitive area of the checkbox.

HTML



		  <label><input id="red" type="checkbox" name="colors" value="red" />Text</label>

This example uses the input type=checkbox element to create two check boxes with explanatory text enclosed in label tags. The onclick events for the checkbox elements call script functions to display a message. The first check box is checked when the page loads.