ListLoop

ListLoop Component

The ListLoop component lets you individually read a list of items and execute events for each item. The component not only loops through a count of items (like the Connectable Loop) but goes further to read the contents of the list and output each item.

When you drag the component onto the automation page, the main properties, methods, and events are combined in the design block. You cannot access them through Object Explorer.

Properties

Property	Description
Broken	Gets a True value when the Break method on the ListLoop has been called.
Item	As each item is read by the ListLoop, the item is contained in this output property for processing by other components in the solution.
List	Collection of items that the ListLoop will read and execute on.

Events

Event	Description
Completed	Triggered when the ListLoop has read all items in the List and the Break method has not been called.
ItemYielded	Triggered when each item in the list has been read.

Methods

Method

Description

Parameters

Result Type

Break

Method that has input and output event nodes. The input halts the execution of the ListLoop. The output event is raised when the ListLoop execution has been halted.

None

Void

StartLoop

Method that has input and output event nodes. The input begins the execution of the ListLoop component and the output is raised when the execution is complete.

Note: This method is not viewable Object Explorer's Configure Type dialog, as it cannot be used independently. The method must always be accessed via the associated ListLoop design block.

None

Void

Related information

Using the ListLoop Component