Description

Executes a callback function for each element.

Syntax

<void> Collection.forEach(<ForEachCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives each element of the collection.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates Collection.forEach in a practical document-editing workflow. Executes a callback function for each element.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

function forEach(s) {
    s.forEach(
        function(item, index, itemCount) {
            if (!item) {
                console.warn("No object was returned.");
                return;
            }
            
            console.log("for each result:", item);
        },
        onTxError
    );
}