Improve your website with a Premium WordPress Theme and Design it in Real Time.
search
HTML CSS JavaScript Appendix
You are here: Reference > JavaScript > client-side > HTML DOM > objects > anchors

anchors collection

Browser support:
Represents a collection of all anchor elements in the document that have a name property specified.
In Internet Explorer, the anchors collection also contains anchor elements that have an id attribute specified.
The elements in the collection are sorted in source code order.
If you need a collection of all anchor elements that have a href property specified, use the links collection.

Syntax:

Properties that reference the object:
•document.anchors
The base interface, through which you can add new functionalities to the anchors collection, is the HTMLCollection interface.

Possible members:

Properties:
length
Returns an integer that specifies the number of elements in the current collection.

This property is read-only.
Methods:
[nameOrIndex]
Returns an element or a collection of elements from the current collection by name or index.

Parameters:

nameOrIndex
Required. A string or a zero-based integer that specifies the element or elements to retrieve.
  • If an integer value is specified, it specifies the index of the element to retrieve.
  • If this parameter is a string, then it specifies a value for the name or id property of the element or elements to retrieve.
Internet Explorer does not support string values.

Return value:

  • If no match is found, it returns undefined.
  • If exactly one match is found, it returns the matching
    • anchor element.
  • If more than one match is found, it returns an anchors sub-collection filled with the matching elements. The sub-collection contains the matching elements in source order.
In Firefox, if more than one match is found, the first matching element is returned.
item (nameOrIndex [, subIndex])
Returns an element or a collection of elements from the current collection by name or index.

Parameters:

nameOrIndex
Required. A string or a zero-based integer that specifies the element or elements to retrieve.
  • If an integer value is specified, it specifies the index of the element to retrieve.
  • If this parameter is a string, then it specifies a value for the name or id property of the element or elements to retrieve.
Firefox does not support string values.
subIndex
Optional. Supported by Internet Explorer only. If more than one matching element is found for the index parameter (possible only if it is a string), the item method creates an anchors sub-collection filled with the matching elements. In that case, the subIndex property specifies the position of the element in the sub-collection to retrieve. In other cases, the subIndex property has no meaning.

Return value:

  • If no match is found, it returns null in Internet Explorer, Firefox and Opera, and returns undefined in Google Chrome and Safari.
  • If exactly one match is found, it returns the matching anchor element.
  • If more than one match is found, it returns an anchors sub-collection filled with the matching elements. The sub-collection contains the matching elements in source order.
namedItem (name)
Returns an element or a collection of elements from the current collection by name.

Parameters:

name
Required. String that specifies a value for the name or id property of the element or elements to retrieve.

Return value:

  • If no match is found, it returns null in Internet Explorer, Firefox and Opera, and returns undefined in Google Chrome and Safari.
  • If exactly one match is found, it returns the matching anchor element.
  • If more than one match is found, it returns an anchors sub-collection filled with the matching elements. The sub-collection contains the matching elements in source order.
In Firefox, if more than one match is found, the first matching element is returned.
tags
Returns a NodeList collection that contains all elements from the current collection with the specified tag name.
urns
Returns a NodeList collection that contains all elements to which the specified behavior is attached.

Example HTML code 1:

This example illustrates the use of the anchors collection:
 
<head>
    <script type="text/javascript">
        function GetAnchors () {
            var message = "";
            for (i = 0; i < document.anchors.length; i++) {
                message += i + ". anchor: " + document.anchors.item (i).innerHTML + "\n";
            }
            alert (message);
        }
    </script>
</head>
<body>
    <a name="an1" href="#">apple</a><br/>
    <a name="an2" href="#">peach</a><br/>
    <a name="an3" href="#">pear</a><br/>
    <br /><br />
    <button onclick="GetAnchors ();">Get anchors!</button>
</body>
Copy Code Print Preview Syntax Highlighter
Did you find this example helpful? yes no

External links:

anchors (MSDN)
anchors (Mozilla Developer Center)
User Contributed Comments

Post Content

Post Content
Search: search
© 2012 Dottoro.com. All rights reserved.