Книга: JavaScript. Подробное руководство, 6-е издание

HTMLOptionsCollection

HTMLOptionsCollection

коллекция элементов Option HTMLCollection

Объект HTMLOptionsCollection является специализированным подтипом HTMLCollection, который представляет элементы Option, имеющиеся в элементе Select. Он переопределяет метод namedItem(), чтобы обеспечить возможность работы с несколькими элементами Option, имеющими одинаковые имена, и определяет методы добавления и удаления элементов. По историческим причинам объект HTMLOptionsCollection определяет доступное для записи свойство length, которое можно использовать для усечения или расширения коллекции.

Свойства

unsigned long length

Возвращает количество элементов в коллекции. Однако, в отличие от свойства length обычного объекта HTMLCollection, это свойство доступно не только для чтения. Если присвоить ему значение меньше текущего, коллекция элементов Option будет усечена, а элементы Option, оказавшиеся за пределами коллекции, будут удалены из элемента Select. Если присвоить свойству length значение больше текущего, будут созданы и добавлены в элемент Select и в коллекцию новые пустые элементы <option/>.

long selectedIndex

Индекс первого выбранного элемента Option в коллекции или -1, если ни один элемент Option не был выбран. Это свойство можно использовать, чтобы программно выбрать требуемый элемент.

Методы

void add(Element option, [any before])

Вставляет элемент option (который должен быть элементом <option> или <optgroup>) в данную коллекцию (и в элемент Select), в позицию, определяемую аргументом before. Если аргумент before имеет значение null, новый элемент вставляется в конец коллекции. Если аргумент before имеет целочисленное значение, новый элемент будет вставлен перед элементом, который в текущий момент имеет этот индекс. Если передать в аргументе before другой элемент Element, option будет вставлен перед этим элементом.

Element item(unsigned long index)

Объект HTMLOptionsCollection наследует этот метод от HTMLCollection . Он возвращает  элеммент с индексом index или null, если индекс выходит за границы коллекции. 

Коллекцию можно также индексировать непосредственно, используя квадратные скобки и не вызывая этот метод явно.

object namedltem(string name)

Возвращает все элементы Option из коллекции, имеющие значение name в атрибуте id или name. Если элементы с таким именем отсутствуют, возвращается значение null. Этот метод можно не вызывать явно, а указать имя в квадратных скобках. Если заданному имени соответствует только один элемент Option, возвращается этот элемент. Если заданному имени соответствует более одного элемента, возвращается объект NodeList с этими элементами. Обратите внимание, что объекты HTMLOptionsCollection можно индексировать непосредственно, используя значение name как имя свойства, вместо явного вызова этого метода.

void remove(long index)

Удаляет из коллекции элемент <option> с индексом index. При вызове без аргумента или со значением аргумента, которое выходит за границы коллекции, может удалить первый элемент коллекции.

Оглавление книги