The HTMLSelectElement interface represents a select HTML Element. These elements also share all of the properties and methods of other HTML elements via the HTMLElement interface.

Documentation HTMLSelectElement by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See:

Variables

autofocus:Bool

Is a Boolean that reflects the autofocus HTML attribute, which indicates whether the control should have input focus when the page loads, unless the user overrides it, for example by typing in a different control. Only one form-associated element in a document can have this attribute specified. 2.0

disabled:Bool

Is a Boolean that reflects the disabled HTML attribute, which indicates whether the control is disabled. If it is disabled, it does not accept clicks.

read onlyform:FormElement

Returns a HTMLFormElement representing the form that this element is associated with. If the element is not associated with of a form element, then it returns null.

length:Int

Is a unsigned long representing the number of option elements in this select element.

multiple:Bool

Is a Boolean that reflects the multiple HTML attribute, which indicates whether multiple items can be selected.

name:String

Is a DOMString that reflects the name HTML attribute, containing the name of this control used by servers and DOM search functions.

read onlyoptions:HTMLOptionsCollection

Returns a HTMLOptionsCollection containing the set of option elements contained by this element.

required:Bool

Is a Boolean that reflects the required HTML attribute, which indicates whether the user is required to select a value before submitting the form. 2.0

selectedIndex:Int

Is a long that reflects the index of the first selected option element. The value -1 indicates no element is selected.

read onlyselectedOptions:HTMLCollection

Returns a live HTMLCollection containing the set of options that are selected.

size:Int

Is a long that reflects the size HTML attribute, which contains the number of visible items in the control. The default is 1, unless multiple is true, in which case it is 4.

read onlytype:String

Returns a DOMString the form control's type. When multiple is true, it returns "select-multiple"; otherwise, it returns "select-one".

read onlyvalidationMessage:String

Returns a DOMString containing a localized message that describes the validation constraints that the control does not satisfy (if any). This attribute is the empty string if the control is not a candidate for constraint validation (willValidate is false), or it satisfies its constraints.

read onlyvalidity:ValidityState

Returns a ValidityState representing the validity state that this control is in.

value:String

Is a DOMString representing the value of the form control (the first selected option).

read onlywillValidate:Bool

Is a Boolean that indicates whether the button is a candidate for constraint validation. It is false if any conditions bar it from constraint validation.

Methods

add (element:EitherType<OptionElement, OptGroupElement>, ?before:EitherType<Element, Int>):Void

Throws:

null

DOMError

checkValidity ():Bool

Checks whether the element has any constraints and whether it satisfies them. If the element fails its constraints, the browser fires a cancelable invalid event at the element (and returns false).

item (index:Int):Element

Gets an item from the options collection for this select element. You can also access an item by specifying the index in array-style brackets or parentheses, without calling this method explicitly.

namedItem (name:String):OptionElement

Gets the item in the options collection with the specified name. The name string can match either the id or the name attribute of an option node. You can also access an item by specifying the name in array-style brackets or parentheses, without calling this method explicitly.

setCustomValidity (error:String):Void

Sets the custom validity message for the selection element to the specified message. Use the empty string to indicate that the element does not have a custom validity error.

Inherited Variables

Defined by DOMElement

read onlyclientHeight:Int

read onlyclientLeft:Int

read onlyclientTop:Int

read onlyclientWidth:Int

read onlyoffsetHeight:Int

read onlyoffsetLeft:Int

read onlyoffsetTop:Int

read onlyoffsetWidth:Int

read onlyscrollHeight:Int

read onlyscrollTopMax:Int

read onlyscrollWidth:Int

read onlytagName:String

Defined by Node

read onlybaseURI:String

Returns a DOMString representing the base URL. The concept of base URL changes from one language to another; in HTML, it corresponds to the protocol, the domain name and the directory structure, that is all until the last '/'.

read onlychildNodes:NodeList

Returns a live NodeList containing all the children of this node. NodeList being live means that if the children of the Node change, the NodeList object is automatically updated.

read onlyfirstChild:Node

Returns a Node representing the first direct child node of the node, or null if the node has no child.

read onlylastChild:Node

Returns a Node representing the last direct child node of the node, or null if the node has no child.

read onlylocalName:String

Returns a DOMString representing the local part of the qualified name of an element.

Note: In Firefox 3.5 and earlier, the property upper-cases the local name for HTML elements (but not XHTML elements). In later versions, this does not happen, so the property is in lower case for both HTML and XHTML. 1.9.2

read onlynamespaceURI:String

The namespace URI of this node, or null if it is no namespace.

Note: In Firefox 3.5 and earlier, HTML elements are in no namespace. In later versions, HTML elements are in the https://www.w3.org/1999/xhtml/ namespace in both HTML and XML trees. 1.9.2

read onlynextSibling:Node

Returns a Node representing the next node in the tree, or null if there isn't such node.

read onlynodeName:String

Returns a DOMString containing the name of the Node. The structure of the name will differ with the name type. E.g. An HTMLElement will contain the name of the corresponding tag, like 'audio' for an HTMLAudioElement, a Text node will have the '#text' string, or a Document node will have the '#document' string.

read onlynodeType:Int

Returns an unsigned short representing the type of the node. Possible values are:

Name Value

ELEMENT_NODE 1
ATTRIBUTE_NODE (deprecated) 2
TEXT_NODE 3
CDATA_SECTION_NODE (deprecated) 4
ENTITY_REFERENCE_NODE (deprecated) 5
ENTITY_NODE (deprecated) 6
PROCESSING_INSTRUCTION_NODE 7
COMMENT_NODE 8
DOCUMENT_NODE 9
DOCUMENT_TYPE_NODE 10
DOCUMENT_FRAGMENT_NODE 11
NOTATION_NODE (deprecated) 12

nodeValue:String

Returns / Sets the value of the current node

read onlyownerDocument:HTMLDocument

Returns the Document that this node belongs to. If no document is associated with it, returns null.

read onlyparentElement:Element

Returns an Element that is the parent of this node. If the node has no parent, or if that parent is not an Element, this property returns null.

read onlyparentNode:Node

Returns a Node that is the parent of this node. If there is no such node, like if this node is the top of the tree or if doesn't participate in a tree, this property returns null.

read onlyprefix:String

Is a DOMString representing the namespace prefix of the node, or null if no prefix is specified.

read onlypreviousSibling:Node

Returns a Node representing the previous node in the tree, or null if there isn't such node.

textContent:String

Returns / Sets the textual content of an element and all its descendants.

Inherited Methods

Defined by DOMElement

animate (frames:Dynamic, ?options:EitherType<Float, Dynamic>):Animation

Throws:

null

DOMError

blur ():Void

Throws:

null

DOMError

closest (selector:String):Element

Throws:

null

DOMError

createShadowRoot ():ShadowRoot

Throws:

null

DOMError

focus ():Void

Throws:

null

DOMError

getAnimations ():Array<Animation>

Returns an array of Animation objects currently active on the element.

getAttributeNS (namespace_:String, localName:String):String

getAttributeNodeNS (namespaceURI:String, localName:String):Attr

getElementsByTagNameNS (namespace_:String, localName:String):HTMLCollection

Throws:

null

DOMError

hasAttributeNS (namespace_:String, localName:String):Bool

insertAdjacentHTML (position:String, text:String):Void

Throws:

null

DOMError

matches (selector:String):Bool

Throws:

null

DOMError

querySelector (selectors:String):Element

Throws:

null

DOMError

querySelectorAll (selectors:String):NodeList

Throws:

null

DOMError

releasePointerCapture (pointerId:Int):Void

Throws:

null

DOMError

removeAttribute (name:String):Void

Throws:

null

DOMError

removeAttributeNS (namespace_:String, localName:String):Void

Throws:

null

DOMError

removeAttributeNode (oldAttr:Attr):Attr

Throws:

null

DOMError

requestFullscreen (?options:Dynamic):Void

Throws:

null

DOMError

setAttribute (name:String, value:String):Void

Throws:

null

DOMError

setAttributeNS (namespace_:String, name:String, value:String):Void

Throws:

null

DOMError

setAttributeNode (newAttr:Attr):Attr

Throws:

null

DOMError

setAttributeNodeNS (newAttr:Attr):Attr

Throws:

null

DOMError

setCapture (retargetToElement:Bool = false):Void

setPointerCapture (pointerId:Int):Void

Throws:

null

DOMError

webkitMatchesSelector (selector:String):Bool

Throws:

null

DOMError

Defined by Node

appendChild (node:Node):Node

Throws:

null

DOMError

cloneNode (deep:Bool = false):Node

Throws:

null

DOMError

compareDocumentPosition (other:Node):Int

Returns the context objects root which optionally includes the shadow root if it is available. 

contains (other:Node):Bool

Returns the context objects root which optionally includes the shadow root if it is available. 

hasChildNodes ():Bool

Returns a Boolean indicating if the element has any child nodes, or not.

insertBefore (node:Node, child:Node):Node

Throws:

null

DOMError

isDefaultNamespace (namespace_:String):Bool

Returns a Boolean which indicates whether or not two nodes are of the same type and all their defining data points match.

isEqualNode (node:Node):Bool

Returns a Boolean which indicates whether or not two nodes are of the same type and all their defining data points match.

lookupNamespaceURI (prefix:String):String

Clean up all the text nodes under this element (merge adjacent, remove empty).

lookupPrefix (namespace_:String):String

Clean up all the text nodes under this element (merge adjacent, remove empty).

normalize ():Void

Clean up all the text nodes under this element (merge adjacent, remove empty).

removeChild (child:Node):Node

Throws:

null

DOMError

replaceChild (node:Node, child:Node):Node

Throws:

null

DOMError

Defined by EventTarget

addEventListener (type:String, listener:Function, capture:Bool = false):Void

addEventListener (type:String, listener:EventListener, capture:Bool = false, ?wantsUntrusted:Bool):Void

Throws:

null

DOMError

dispatchEvent (event:Event):Bool

Throws:

null

DOMError

removeEventListener (type:String, listener:Function, capture:Bool = false):Void

removeEventListener (type:String, listener:EventListener, capture:Bool = false):Void

Throws:

null

DOMError