frames Collection

Internet Development Index

---

Retrieves a collection of all window objects defined by the given document or defined by the document associated with the given window.

Syntax

[ oColl = ] object.frames

[ oObject = ] object.frames(vIndex [, iSubIndex])

Possible Values

oColl	Array of window objects.
oObject	Reference to an individual item in the array of elements contained by the object.
vIndex	Required. Integer or string that specifies the element or collection to retrieve. If this parameter is an integer, the method returns the element in the collection at the given position, where the first element has value 0, the second has 1, and so on. If this parameter is a string and there is more than one element with the name or id property equal to the string, the method returns a collection of matching elements.
iSubIndex	Optional. Position of an element to retrieve. This parameter is used when vIndex is a string. The method uses the string to construct a collection of all elements that have a name or id property equal to the string, and then retrieves from this collection the element at the position specified by iSubIndex.

Members Table

The following table lists the members exposed by the frames object. Click a tab on the left to choose the type of member you want to view.

Attributes/Properties

Property	Description
length	Sets or retrieves the number of objects in a collection.

Methods

Method	Description
item	Retrieves an object from the filters collection or various other collections.
namedItem	Retrieves an object or a collection from the specified collection.

Remarks

If the HTML source document contains a body tag, the collection contains one window for each iframe object in the document. If the source document contains frameSet tags, the collection contains one window for each frame tag in the document. In both cases, the order is determined by the HTML source.

This collection contains only window objects and does not provide access to the corresponding frame and iframe objects. To access these objects, use the all collection for the document containing the objects.

Although you can use names with the item method on this collection, the method never returns a collection. Instead, it always returns the first window having the given name. To ensure that all windows are accessible, make sure that no two windows in a document have the same name.

Examples

This example in JScript® (compatible with ECMA 262 language specification) shows how to display the URLs of the HTML documents contained in windows created by the iframe objects in the document.

var frm = document.frames;
for (i=0; i < frm.length; i++)
alert(frm(i).location);

This example in JScript shows how to display the name of each window defined by frame tags in the parent window of the current document.

var frm = window.parent.frames;
for (i=0; i < frm.length; i++)
alert(frm(i).name);

Standards Information

There is no public standard that applies to this collection.

Applies To

	document, window