Ordered collection of component and value pairs typically used to allow objects to be found via a key value

Ancestors - Collection (PRIM_COLL) Object (PRIM_OBJT)

Details

A Keyed collection is an unordered sequence of components instances identified by a key value. No duplicates of the key value are allowed.
 
A keyed collection is keyed by a repository defined field, giving each collection item a unique identifier.
 
Unlike all other collection types which require an instance to be created before it can be stored, Keyed collection can automatically create their contents simply by refering to the key value.

Examples

Defining a keyed collection. This collection stores instances of any component that inherits from Prim_Form, identified by a number.

Define_Com Class(#Prim_kcol<#Prim_form #Std_num>) Name(#Forms)

Collection items can be accessed using any value that matches the data type specified as the key. If the Style property is Factory, this will also create the collection item instance if it doesn't yet exist.

#Forms<123>.Caption := "Form 123"

or using another variable

#Forms<#ID>.Caption := "Form 123"

All collection items can be addressed as follows. Here, all the forms in the collection are being closed.

#Forms<>.Close

The FOR command can also be used to iterate over the collection contents. The items will be returned in the order of the key value, in this case numeric sequence.

For each(#Form) in (#Forms)
   ...
Endfor

To monitor for an event from any instance in the collection, <> can be appended to an EVTROUTINE. The COM_SENDER parameter will provide access to the instance firing the event.

Evtroutine Handling(#Forms<>.Closing) Com_Sender(#Sender)
 
   #Com_owner.AddEvent(("&1 closed").Substitute(#Sender.Caption))
 
Endroutine

Properties

Events

Methods

See also

All Component Classes

Technical Reference

Febuary 18 V14SP2