SelectElement

package js.html

extends Element › DOMElement › Node › EventTarget

@:native("HTMLSelectElement") Available on js

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:

https://developer.mozilla.org/en-US/docs/Web/API/HTMLSelectElement

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 only form: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 only options: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 only selectedOptions: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 only type:String

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

read only validationMessage: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 only validity: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 only willValidate: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.