In order to access this site you need to enable JavaScript!

You are here: Reference > JavaScript > client-side > xml handling > properties > snapshotLength (XPathResult)

snapshotLength property (XPathResult)

Browser support:

Returns the length of the snapshots collection.

The XPathResult object represents the result of the evaluate method.

The type of the result depends on the fourth parameter of the evaluate method, or, if its value is ANY_TYPE, on the expression specified by the first parameter. With the resultType property, the type of the result can be retrieved. If the value of the resultType property is UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE, then the result contains snapshots for all nodes that match the expression.

In that case, the snapshotLength property can be used to retrieve the number of matching nodes in the snapshots collection. Use the snapshotItem method to get the matching nodes from the snapshots collection by position.

Syntax:

object.snapshotLength;

You can find the related objects in the Supported by objects section below.

This property is read-only.

Possible values:

Integer that retrieves the length of the snapshots collection.

Default: this property has no default value.

Example HTML code 1:

This example shows how to get all span elements that are immediate children of a given element:

<head>
    <style>
        .level1 {color:red;}
        .level2 {color:blue;}
        .level3 {color:green;}
    </style>
    <script type="text/javascript">
        function GetSpanElements () {
            var message = "";

            if (document.evaluate) {    // Firefox, Opera, Google Chrome and Safari
                var container = document.getElementById ("container");
                var xPathRes = document.evaluate ( 'span', container, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);

                message += xPathRes.snapshotLength + " span elements are found.<br />";
                for (var i = 0; i < xPathRes.snapshotLength; i++) {
                    var actualSpan = xPathRes.snapshotItem (i);
                    message += "The contents of the " + i + ". child span element: <b>" + actualSpan.innerHTML + "</b><br />";
                }
            }
            else {  // Internet Explorer
                message = "Your browser does not support the evaluate method!";
            }

            var info = document.getElementById ("info");
            info.innerHTML = message;
        }
    </script>
</head>
<body onload="GetSpanElements ()">
    <span class="level1">Span 1</span>
    <div id="container">
        <span class="level2">Span 2</span>
        <div>
            <span class="level3">Span 3</span>
            <span class="level3">Span 4</span>
        </div>
        <span class="level2">Span 5</span>
        <span class="level2">Span 6</span>
    </div>
    <span class="level1">Span 7</span>
    <br /><br />
    <div id="info" style="background-color:#e0b0b0; width:400px"></div>
</body>