Keyed Collection Iterator (PRIM_KCIT)
Allows the FOR command to iterate over collection of objects
Ancestors - Collection Iterator (PRIM_COIT)Object (PRIM_OBJT)
Details
An iterator component enables iteration over the content of the collection. The simplest technique for iterating over a collection is to use the FOR/ENDFOR commands.
Properties
| Name | Description |
|---|---|
| AtEnd | Is the iterator at the end of the collection? |
| ComponentClassName | ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT) |
| ComponentMembers | ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT) |
| ComponentPatternName | ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT) |
| ComponentTag | Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT) |
| ComponentType | ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT) |
| ComponentTypeName | ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT) |
| Current | Current object in the collection |
| CurrentKey | CurrentKey returns the key of the current component accessed by the iterator. |
| Name | Name identifies the component Inherited from Object (PRIM_OBJT) |
| Owner | Owner owns this component Inherited from Object (PRIM_OBJT) |
| Parent | The component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances Inherited from Object (PRIM_OBJT) |
Events
| Name | Description |
|---|---|
| CreateInstance | CreateInstance is signalled when an instance of a component is created Inherited from Object (PRIM_OBJT) |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Object (PRIM_OBJT) |
Methods
| Name | Description |
|---|---|
| MoveNext | Move to the next object in the collection
Result |
| MoveNext | The MoveNext method moves the iterator to the next component Inherited from Collection Iterator (PRIM_COIT) Result |
| Reset | Start iterating again from the beginning |
See also
LANSA Version 15, April 2020