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 also:
Variables
autofocus:Bool
A Boolean
reflecting 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
A Boolean
reflecting the disabled
HTML attribute, which indicates whether the control is disabled. If it is disabled, it does not accept clicks.
read onlyform:FormElement
An HTMLFormElement
referencing the form that this element is associated with. If the element is not associated with of a form
element, then it returns null
.
multiple:Bool
A Boolean
reflecting the multiple
HTML attribute, which indicates whether multiple items can be selected.
name:String
A DOMString
reflecting the name
HTML attribute, containing the name of this control used by servers and DOM search functions.
read onlyoptions:HTMLOptionsCollection
An HTMLOptionsCollection
representing the set of option
elements contained by this element.
required:Bool
A Boolean
reflecting the required
HTML attribute, which indicates whether the user is required to select a value before submitting the form. 2.0
selectedIndex:Int
A long
reflecting the index of the first selected option
element. The value -1
indicates no element is selected.
read onlyselectedOptions:HTMLCollection
An HTMLCollection
representing the set of option
elements that are selected.
size:Int
A long
reflecting 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
A DOMString
represeting the form control's type. When multiple
is true
, it returns "select-multiple"
; otherwise, it returns "select-one"
.
read onlyvalidationMessage:String
A DOMString
representing 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
A ValidityState
reflecting the validity state that this control is in.
value:String
A DOMString
reflecting the value of the form control (the first selected option). Returns the value attribute of the option element or if it is missing, the text attribute.
read onlywillValidate:Bool
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
Adds an element to the collection of option
elements for this select
element.
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.
remove():Void
remove(index:Int):Void
Removes the element at the specified index from the options collection for this select element.
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.