Export (0) Print
Expand All

item method

Retrieves an object from an areas collection.

Syntax

var retval = areas.item(name, index);

Parameters

name [in]

Type: Variant

Variant of type Integer or String that specifies the object or collection to retrieve. If this parameter is an integer, it is the zero-based index of the object. If this parameter is a string, all objects with matching name or id properties are retrieved, and a collection is returned if more than one match is made.

index [in, optional]

Type: Variant

Variant of type Integer that specifies the zero-based index of the object to retrieve when a collection is returned.

Return value

Type: Object

Returns an object or a collection of objects if successful, or null otherwise.

Standards information

There are no standards that apply here.

Remarks

Windows Internet Explorer 8 and later. In IE8 Standards mode, the index parameter is not used. For more information, see Defining Document Compatibility.

Call QueryInterface on the IDispatch interface pointer retrieved to pdisp to obtain the correct interface for the object or collection.

This function returns S_OK even if the element is not found. You should check the value of the pdisp (IDispatch) pointer returned by this call. If the value of the pointer is NULL, the element was not found and the call was not successful.

The item method cannot retrieve input type=image elements from a form. To access all elements contained in a form, call QueryInterface on IHTMLFormElement and request an IHTMLElement interface. Use the children property of the IHTMLElement interface to retrieve a collection of all elements in the form.

Examples

The following example uses the item method to retrieve the alt attribute from each object in the areas collection of a map object.


<body>
<img src ="examples.png" width="200" height="300" 
	alt="Example" usemap ="#example" />
<map id ="example">
  <area shape ="rect" coords ="0,0,100,50" href ="rect.htm" 
    target ="_blank" alt="rectangle" />
  <area shape ="circle" coords ="100,150,10" href ="circle.htm" 
    target ="_blank" alt="circle" />
  <area shape ="poly" coords ="100,300,150,250,200,300" href ="triangle.htm" 
    target ="_blank" alt="triangle" />
</map>
<script type="text/jscript">
  window.onload = function() {
    var oMap = document.getElementsByTagName("MAP")[0];
    var oColl = oMap.areas;
    var sAttr = new Array();
	  
    for (i=0; i<oColl.length; i++) {     
      sAttr[i] = oColl.item(i).getAttribute("alt");                
    }
    alert("The map has " + oColl.length + " area elements:" + "\n" +
      sAttr[0] + "\n" + sAttr[1] + "\n" + sAttr[2]);  
  }
</script>
</body>

See also

areas

 

 

Show:
© 2014 Microsoft