Version 6.3.8 for Windows
 —  Dialog Component Reference  —

CLIENT-KEY

Alphanumeric data associated with a dialog or a dialog element. Often, it is useful to store a text string with a dialog element to allow for direct access of the string. The CLIENT-DATA attribute enables you to assign an integer value to many dialog elements; the CLIENT-KEY attribute is used in conjunction with the attribute CLIENT-VALUE and enables you to store alphanumeric key/string pairs.

You first assign a value to the CLIENT-KEY attribute. This determines the key under which the string is to be stored for an instance of a dialog element. You then assign an alphanumeric string to the CLIENT-VALUE attribute of the dialog element.

It is advisable to reuse keys that are not needed because you may use only a limited number of keys.

You can query the CLIENT-VALUE of a dialog element by first setting the CLIENT-KEY attribute of the dialog element to the desired value and then accessing the CLIENT-VALUE attribute.

Applies to Dialogs (all types) and all dialog elements, date/time picker control, image control, image list control, list view column, list view control, list view item, progress bar control, slider control, spin control, tree view control, tree view item.
Data Type A253
Default Value Empty string (no key/value pair will be assigned to the dialog element)
Possible Values Empty string or any text string

Top of page