Dictionary Collection - IsEqual Event

Fired whenever the collection needs to compare two items

Member of Dictionary Collection (PRIM_DCOL)

Parameters

Name

Type

Data Type

Description

Object

*Input

PRIM_OBJT

Instance to compare

Subject

*Input

PRIM_OBJT

Instance to compare

Equal

*Both

Boolean

Return True if the two instances are considered equal

Details

The IsEqual event is fired whenever the collection needs to determine if two components are equal.

This is typically handled automatically when performing actions that require searching such as Remove or testing for duplicates. The event allows you to determine whether the object being tested is the object being searched for.

This feature is provide for completeness and is unlikely to be required for most development purposes.

Example

The source and object parameters contain the two instances to compare.

Here the name property of the two "Customer" objects is being tested.

     Evtroutine Handling(#Collection.IsEqual) Subject(#Subject) Object(#Object) Equal(#Equal)
#Equal := #Subject.CustomerName.Uppercase = #Object.CustomerName.Uppercase
Endroutine

See also

All Component Classes

Technical Reference

  • No labels