ImageGear .NET v25.2 - Updated
ImageGear.Web.UI Library / ImageGear.Web.UI Namespace / ImGearDocumentCollection class / forEach Method

In This Topic
    forEach Method
    In This Topic
    Calls the specified function once for each ImGearDocument in the collection.
    Syntax
    ASP.NET Ajax JavaScript (Specification) 
    function forEach( 
       method : function,
       context : object
    ) : (Any);
    ASP.NET Ajax JavaScript (Usage) 
    var resultVar = instanceOfImGearDocumentCollection.forEach(function,object);

    Parameters

    method
    The function to call.
    context
    An object that holds the context of the call.
    Remarks

    This function calls the specified function once for each ImGearDocument in the collection.

    When forEach calls the function, it will set this to context, the first function parameter to a copy of the ImGearDocument being enumerated, the second function parameter to the zero-based index of the iteration, and the third function parameter to the collection.

    This function copies the list of documents before starting the enumeration, so you can safely make changes to the collection during the enumeration process. Any document that you delete during the enumeration will be enumerated; any document that you add during the enumeration will not be enumerated, and any documents that you change during the enumeration will be enumerated with their new value. Note: The read-only properties in the documents of the collection, for example, documentIdentifier and encodedDocumentIdentifier cannot be changed, refer to the ImGearDocument properties for details.

    See Also