Denotes one choice in a SELECT element.

Members Table

The following table lists the members exposed by the option object.

Attributes/Properties

Attribute	Property	Description
aria-activedescendant	ariaActivedescendant	Sets or retrieves the currently active child element.
aria-busy	ariaBusy	Sets or retrieves a value indicating whether a live region is finished updating.
aria-checked	ariaChecked	Sets or retrieves the checked state of this element.
aria-controls	ariaControls	Sets or retrieves the list of elements that are controlled by the current element.
aria-describedby	ariaDescribedby	Sets or retrieves a list of elements that describe the current object.
aria-disabled	ariaDisabled	Sets or retrieves the disabled state of this element.
aria-expanded	ariaExpanded	Sets or retrieves the expanded state of this element.
aria-flowto	ariaFlowto	Sets or retrieves the recommended reading order of content.
aria-haspopup	ariaHaspopup	Sets or retrieves a value indicating whether this element may display a pop-up window.
aria-hidden	ariaHidden	Sets or retrieves the hidden state of this element.
aria-invalid	ariaInvalid	Sets or retrieves the error state of this element.
aria-labelledby	ariaLabelledby	Sets or retrieves a list of elements that provide a label for the current object.
aria-level	ariaLevel	Sets or retrieves the level of this element.
aria-live	ariaLive	Sets or retrieves how assistive technology should announce updates to live regions.
aria-multiselect	ariaMultiselect	Sets or retrieves the multiple-selection state of this element.
aria-owns	ariaOwns	Sets or retrieves a list of child objects, including elements that are not direct descendants of the current object.
aria-posinset	ariaPosinset	Sets or retrieves the current position of an item within a set.
aria-pressed	ariaPressed	Sets or retrieves the pressed state of a button that can be toggled.
aria-readonly	ariaReadonly	Sets or retrieves the read-only state of this element.
aria-relevant	ariaRelevant	Sets or retrieves which changes to a live region are relevant.
aria-required	ariaRequired	Sets or retrieves the form-completion requirement of this element.
aria-secret	ariaSecret	Sets or retrieves the secret state of this element.
aria-selected	ariaSelected	Sets or retrieves the selection state of this element.
aria-setsize	ariaSetsize	Sets or retrieves the set size of this element.
aria-valuemax	ariaValuemax	Sets or retrieves the maximum value that a user can provide.
aria-valuemin	ariaValuemin	Sets or retrieves the minimum value that a user can provide.
aria-valuenow	ariaValuenow	Sets or retrieves the current value of the element.
	attributes	Retrieves a collection of attributes of the object.
	canHaveChildren	Gets a value indicating whether the object can contain child objects.
canHaveHTML	canHaveHTML	Retrieves the value indicating whether the object can contain rich HTML markup.
CLASS	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.
	constructor	Returns a reference to the constructor of an object.
DATAFORMATAS	dataFormatAs	Sets or retrieves the rendering format for the data supplied to the object.
DATASRC	dataSrc	Sets or retrieves the source of the data for data binding.
	defaultSelected	Sets or retrieves the status of an option.
DIR	dir	Sets or retrieves the reading order of the object.
DISABLED	disabled	Sets or retrieves a value that indicates whether the user can interact with the object.
	firstChild	Retrieves a reference to the first child in the childNodes collection of the object.
	form	Retrieves a reference to the form that the object is embedded in.
ID	id	Sets or retrieves the string identifying the object.
	index	Sets or retrieves the ordinal position of an option in a list box.
	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.
LABEL	label	Sets or retrieves a value that you can use to implement your own label functionality for the object.
LANG	lang	Sets or retrieves the language to use.
LANGUAGE	language	Sets or retrieves the language in which the current script is written.
	lastChild	Retrieves a reference to the last child in the childNodes collection of an object.
	nextSibling	Retrieves a reference to the next child of the parent for the object.
	nodeName	Retrieves the name of a particular type of node.
	nodeType	Retrieves the type of the requested node.
	nodeValue	Sets or retrieves 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.
	onOffBehavior	Gets an object that indicates whether the specified Microsoft DirectAnimation behavior is running.
	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.
	previousSibling	Retrieves a reference to the previous child of the parent for the object.
	readyState	Retrieves the current state of the object.
role	role	Sets or retrieves the role for this element.
	scopeName	Gets the namespace defined for the 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.
SELECTED	selected	Sets or retrieves whether the option in the list box is the default item.
	tagName	Retrieves the tag name of the object.
	tagUrn	Sets or gets the Uniform Resource Name (URN) specified in the namespace declaration.
	text	Sets or retrieves the text string specified by the option tag.
	uniqueID	Retrieves an autogenerated, unique identifier for the object.
VALUE	value	Sets or retrieves the value which is returned to the server when the form control is submitted.

Behaviors

Behavior	Description
clientCaps	Provides information about features supported by Internet Explorer, as well as a way for installing browser components on demand.
download	Downloads a file and notifies a specified callback function when the download is complete.
homePage	Contains information about a user's homepage.
httpFolder	Contains scripting features that enable browser navigation to a folder view.
saveFavorite	Enables the object to persist data in a favorite Web site.
saveHistory	Enables the object to persist data in the browser history.
time	Provides an active timeline for an HTML element.
time2	Provides an active timeline for an HTML element or group of elements.
userData	Enables the object to persist data in user data.

Collections

Collection	Description
attributes	Retrieves the collection of attributes belonging to the object.
behaviorUrns	Returns a collection of Uniform Resource Name (URN) strings identifying the behaviors attached to the element.
childNodes	Retrieves a collection of HTML Elements and TextNode objects that are direct descendants of the specified object.
children	Retrieves a collection of DHTML Objects that are direct descendants of the object.

Events

Event	Description
onafterupdate	Fires on a databound object after successfully updating the associated data in the data source object.
onbeforecopy	Fires on the source object before the selection is copied to the system clipboard.
onbeforeupdate	Fires on a databound object before updating the associated data in the data source object.
oncellchange	Fires when data changes in the data provider.
oncopy	Fires on the source element when the user copies the object or selection, adding it to the system clipboard.
ondataavailable	Fires periodically as data arrives from data source objects that asynchronously transmit their data.
ondatasetchanged	Fires when the data set exposed by a data source object changes.
ondatasetcomplete	Fires to indicate that all data is available from the data source object.
onerrorupdate	Fires on a databound object when an error occurs while updating the associated data in the data source object.
onfilterchange	Fires when a visual filter changes state or completes a transition.
onlayoutcomplete	Fires when the print or print preview layout process finishes filling the current LayoutRect object with content from the source document.
onlosecapture	Fires when the object loses the mouse capture.
onpropertychange	Fires when a property changes on the object.
onreadystatechange	Fires when the state of the object has changed.
onresize	Fires when the size of the object is about to change.
onrowenter	Fires to indicate that the current row has changed in the data source and new data values are available on the object.
onrowexit	Fires just before the data source control changes the current row in the object.
onrowsdelete	Fires when rows are about to be deleted from the recordset.
onrowsinserted	Fires just after new rows are inserted in the current recordset.
onscroll	Fires when the user repositions the scroll box in the scroll bar on the object.
onselectstart	Fires when the object is being selected.
ontimeerror	Fires whenever a time-specific error occurs, usually as a result of setting a property to an invalid value.

Methods

Method	Description
addBehavior	Attaches a behavior to the element.
appendChild	Appends an element as a child to the object.
applyElement	Makes the element either a child or parent of another element.
attachEvent	Binds the specified function to an event, so that the function gets called whenever the event fires on the object.
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.
componentFromPoint	Returns the component located at the specified coordinates via certain events.
contains	Checks whether the given element is contained within the object.
detachEvent	Unbinds the specified function from the event, so that the function stops receiving notifications when the event fires.
doScroll	Simulates a click on a scroll bar component.
dragDrop	Initiates a drag event.
fireEvent	Fires a specified event on the object.
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.
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.
getExpression	Retrieves the expression for the given property.
hasAttribute	Determines whether an attribute with the specified name exists.
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.
mergeAttributes	Copies all read/write attributes to the specified element.
normalize	Merges adjacent TextNode objects to produce a normalized document object model.
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.
removeBehavior	Detaches a behavior from the element.
removeChild	Removes a child node from the object.
removeExpression	Removes the expression from the specified property.
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.
setAttribute	Sets the value of the specified attribute.
setAttributeNode	Sets an attribute object node as part of the object.
setCapture	Sets the mouse capture to the object that belongs to the current document.
setExpression	Sets an expression for the specified object.
swapNode	Exchanges the location of two objects in the document hierarchy.

Objects

Object	Description
currentStyle	Represents the cascaded format and style of the object as specified by global style sheets, inline styles, and HTML attributes.
runtimeStyle	Represents the cascaded format and style of the object that overrides the format and style specified in global style sheets, inline styles, and HTML attributes.
style	Represents the current settings of all possible inline styles for a given element.

Prototypes

Object	Description
HTMLOptionElement Constructor	Defines the properties and methods inherited by objects in the HTMLOptionElement Constructor prototype chain.

Styles

Style attribute	Style property	Description
background-attachment	backgroundAttachment	Sets or retrieves how the background image is attached to the object within the document.
background-color	backgroundColor	Sets or retrieves the color behind the content of the object.
-ms-background-position-x	backgroundPositionX	Sets or retrieves the x-coordinate of the backgroundPosition property.
-ms-background-position-y	backgroundPositionY	Sets or retrieves the y-coordinate of the backgroundPosition property.
-ms-behavior	behavior	Sets or retrieves the location of the Dynamic HTML (DHTML) behavior.
clear	clear	Sets or retrieves whether the object allows floating objects on its left side, right side, or both, so that the next text displays past the floating objects.
color	color	Sets or retrieves the color of the text of the object.
direction	direction	Sets or retrieves the reading order of the object.
	hasLayout	Gets a value that indicates whether the object has layout.
height	height	Sets or retrieves the height of the object.
-ms-layout-flow	layoutFlow	Sets or retrieves the direction and flow of the content in the object.
-ms-layout-grid	layoutGrid	Sets or retrieves the composite document grid properties that specify the layout of text characters.
-ms-layout-grid-mode	layoutGridMode	Sets or retrieves whether the text layout grid uses two dimensions.
max-height	maxHeight	Sets or retrieves the maximum height for an element.
max-width	maxWidth	Sets or retrieves the maximum width for an element.
min-height	minHeight	Sets or retrieves the minimum height for an element.
min-width	minWidth	Sets or retrieves the minimum width for an element.
	pixelBottom	Sets or retrieves the bottom position of the object.
	pixelHeight	Sets or retrieves the height of the object.
	pixelLeft	Sets or retrieves the left position of the object.
	pixelRight	Sets or retrieves the right position of the object.
	pixelTop	Sets or retrieves the top position of the object.
	pixelWidth	Sets or retrieves the width of the object.
	posBottom	Sets or retrieves the bottom position of the object in the units specified by the bottom attribute.
	posHeight	Sets or retrieves the height of the object in the units specified by the height attribute.
	posLeft	Sets or retrieves the left position of the object in the units specified by the left attribute.
	posRight	Sets or retrieves the right position of the object in the units specified by the right attribute.
	posTop	Sets or retrieves the top position of the object in the units specified by the top attribute.
	posWidth	Sets or retrieves the width of the object in the units specified by the width attribute.
-ms-text-autospace	textAutospace	Sets or retrieves the autospacing and narrow space width adjustment of text.
-ms-text-underline-position	textUnderlinePosition	Sets or retrieves the position of the underline decoration that is set through the textDecoration property of the object.
unicode-bidi	unicodeBidi	Sets or retrieves the level of embedding with respect to the bidirectional algorithm.
width	width	Sets or retrieves the width of the object.
-ms-word-wrap	wordWrap	Sets or retrieves whether to break words when the content exceeds the boundaries of its container.
-ms-writing-mode	writingMode	Sets or retrieves the direction and flow of the content in the object.
-ms-zoom	zoom	Sets or retrieves the magnification scale of the object.

Remarks

As of Microsoft Internet Explorer 5 and later, the OPTION elements are part of the all collection. For earlier versions, you can gain access to these elements by applying the options collection to the SELECT element.

You can create new OPTION elements dynamically with the document.createElement method, but you cannot change properties until the new element is added to a SELECT object. Or, you can create fully formed elements by using the Option object, as follows:

 var opt = new Option( 'Text', 'Value', fDefaultSelected ); 

You can add OPTION elements only to a SELECT element that is located in the same window where the OPTION elements are created.

Except for background-color and color, style settings applied through the style object for the option element are ignored. In addition, style settings applied directly to individual options override those applied to the containing SELECT element as a whole.

This element is a block element.

This element does not require a closing tag.

Examples

This example uses the OPTION element to create individual items in a drop-down list box.

<SELECT ID="oCars" SIZE="1" onchange="fnChange()">
<OPTION VALUE="1">BMW
<OPTION VALUE="2">PORSCHE
<OPTION VALUE="3" SELECTED>MERCEDES
</SELECT>
<TEXTAREA ID="oData"></TEXTAREA>

This example uses the options collection to append the selected item of the list box in a text area.

<SCRIPT LANGUAGE="JScript">
function fnChange(){
   oData.value+=oCars.options[oCars.selectedIndex].text + "\n";
}
</SCRIPT>

Standards Information

This object is defined in HTML 3.2 .

See Also

multiple