FormControl.configurationKeyEx Method

Article
04/11/2014

Retrieves a list that contains the IDs of configuration keys that are in effect for the control.

Syntax

public List configurationKeyEx()

Run On

Client

Return Value

Type: List Class
A list that contains the IDs of configuration keys that are in effect for the control.

Remarks

The returned list does not contain duplicate IDs.

If the control is bound to a data source, the returned list of configuration key IDs also includes the configuration key ID for the table and field. The returned list also contains any configuration key IDs that are applied to the properties, extended data type, or enumType methods.

Examples

The following example shows how to retrieve the configuration key IDs for a control.

DictConfigurationKey dck; 
configurationKeyId cki; 
List list; 
ListEnumerator enum; 
 
// objCtrl previously assigned. 
list = objCtrl.configurationKeyEx(); 
if (0 != list.elements()) 
{ 
    enum = list.getEnumerator(); 
    while (enum.moveNext()) 
    { 
       dck = new DictConfigurationKey(enum.current()); 
       if (dck) 
       { 
        print strfmt("Configuration Key ID: %1 Configuration Key Name: %2", 
                     enum.current(), 
                     dck.name() ); 
       } 
    } 
}