DynaDictionary Methods
The methods defined in the DynaDictionary class are summarized in the following table.
| Method | Description |
|---|---|
| addExternalKey | Adds an external key definition |
| addExternalKeyWithSortOrder | Adds an external key definition including the sort order |
| addMemberKey | Adds a member key definition |
| addMemberKeyWithSortOrder | Adds a member key definition including the sort order |
| clearKeys | Clears existing key definitions |
| endKeys | Indicates the end of a single or multiple key definition |
| isValid | Returns true when the dynamic dictionary is fully defined |
| putAtKey | Adds a specified key to a dynamic dictionary |
| setMembership | Sets or changes the membership of a dynamic dictionary |
| tryAdd | Attempts to add the specified value to the dynamic dictionary |
| tryAddDeferred | Executes a deferred attempt to add a value to the dynamic dictionary |
| tryCopy | Copies the values from the receiver dynamic dictionary to the specified target collection that are not present in the target collection, and returns a reference to the target collection |
| tryCopyFrom | Copies the values that are not present in the receiver from the collection specified in the sourceCollection parameter to the receiver |
| tryPutAtKey | Specifies whether the specified (key, value) pair is added to the dynamic dictionary |
| tryPutAtKeyDeferred | Executes a deferred attempt to add a specified key and value pair to the dynamic dictionary |
| tryRemove | Attempts to remove the specified value from the dynamic dictionary |
| tryRemoveDeferred | Executes a deferred attempt to remove the specified value from the dynamic dictionary |
| tryRemoveKey | Attempts to remove an item with a specified key from a dictionary if it is present |
| tryRemoveKeyDeferred | Executes a deferred attempt to remove an item with a specified key from a dictionary if it is present |
| tryRemoveKeyEntry | Specifies whether the specified (key, value) pair is removed from the dynamic dictionary |
| tryRemoveKeyEntryDeferred | Executes a deferred attempt to remove a specified key and value pair from the dynamic dictionary |
For examples of the use of DynaDictionary class methods, see "Using Dynamic Dictionaries", later in this chapter.
