Dictionary Methods

The methods defined in the Dictionary class are summarized in the following table.

Method Description
createIterator Creates an iterator for the dictionary
getAtKey Returns an object in the receiver collection at the specified key
getAtKeyGeq Returns an object in the receiver collection with a key greater than or equal to the specified key
getAtKeyGtr Returns an object in the receiver collection with a key greater than the specified key
getAtKeyLeq Returns an object in the receiver collection with a key equal to or less than the specified key
getAtKeyLss Returns an object in the receiver collection with a key less than the specified key
getIteratorKeys Retrieves the keys of a dictionary while iterating through the dictionary
includesKey Returns true if the receiver contains an entry at the specified key
removeKey Removes an item with a specified key from a dictionary
removeKeyEntry Removes duplicated key entries from dictionaries
startKeyGeq Sets a start position within a collection for an Iterator object at the object equal to or after the specified key
startKeyGtr Sets a start position within a collection for an Iterator object at the next object after the specified key
startKeyLeq Sets a start position within a collection for an Iterator object at the object equal to or before the specified key
startKeyLss Sets a start position within a collection for an Iterator object at the object before the specified key
stringKeyCompareGeq Returns true if the first string parameter is greater than or equal to the second string parameter
stringKeyCompareGtr Returns true if the first string parameter is greater than to the second string parameter
stringKeyCompareLeq Returns true if the first string parameter is less than or equal to the second string parameter
stringKeyCompareLss Returns true if the first string parameter is less than or equal to the second string parameter
tryCopy__ Copies the values from the receiver dictionary to the specified target collection that are not present in the target collection, and returns a reference to the target collection
tryPutAtKey Specifies whether the specified (key, value) pair is added to the dictionary
tryPutAtKeyDeferred Executes a deferred attempt to add a specified key and value pair to the dictionary
tryRemoveKey Attempts to remove a single (key, value) pair from the dictionary
tryRemoveKeyEntry Specifies whether the specified (key, value) pair is removed from the dictionary
tryRemoveKeyEntryDeferred Executes a deferred attempt to remove a specified key and value pair from the dictionary

Use the startKey methods to start or restart at a selected position in the dictionary, or to synchronize a list box or any list style view that has an associated dictionary of objects.