Enumerator

Non-standard. Do not use!
This object is a Microsoft extension. It is supported in Internet Explorer only, not in Windows 8.x Store apps.

The Enumerator object enables enumeration of items in a collection.

Syntax

enumObj = new Enumerator([collection])

Parameters

enumObj
The variable name to which the Enumerator object is assigned.
collection Optional
Any Collection object.

Remarks

Collections differ from arrays in that the members of a collection are not directly accessible. Instead of using indexes, as you would with arrays, you can move the current item pointer only to the first or next element of a collection.

The Enumerator object provides a way to access any member of a collection and behaves similarly to the For...Each statement in VBScript.

Example

The following code shows the usage of the Enumerator object:

var bytesPerGB = 1024 * 1024 * 1024;  

var fso = new ActiveXObject("Scripting.FileSystemObject");  

document.write(fso.Drives);  
var e = new Enumerator(fso.Drives);  

var driveString = "";  

e.moveFirst();  
while (e.atEnd() == false)  
{  
    var drv = e.item();  

    driveString += drv.Path + " - ";  

    if (drv.IsReady){  
        var freeGB = drv.FreeSpace / bytesPerGB;  
        var totalGB = drv.TotalSize / bytesPerGB;  

        driveString += freeGB.toFixed(3) + " GB free of ";  
        driveString += totalGB.toFixed(3) + " GB";  
    }  
    else{  
        driveString += "Not Ready";  
    }  

    driveString += "<br />";;  

    e.moveNext();  
}  
document.write(driveString);  

// Output: <drive information

Properties

The Enumerator object has no properties.

Methods

Enumerator.atEnd
Returns a Boolean value indicating if the enumerator is at the end of the collection.
Enumerator.item
Returns the current item in the collection.
Enumerator.moveFirst
Resets the current item in the collection to the first item.
Enumerator.moveNext
Moves the current item to the next item in the collection.

Requirements

Supported in the following document modes: Quirks, Internet Explorer 6 standards, Internet Explorer 7 standards, Internet Explorer 8 standards, Internet Explorer 9 standards, and Internet Explorer 10 standards. Not supported in Windows 8.x Store apps.

See also

Document Tags and Contributors

Contributors to this page: khorne3, erikadoyle
Last updated by: khorne3,