Share via


FormComboBoxControl.configurationKey Method

Gets or sets the configuration key that is assigned to the control.

Syntax

public ConfigurationKeyId configurationKey([ConfigurationKeyId value])

Run On

Client

Parameters

Return Value

Type: ConfigurationKeyId Extended Data Type
The ID of the configuration key that is assigned to the control.

Remarks

The configuration key is used to determine whether this control can be displayed. If the configuration key is disabled in the system, the control is not displayed in the form.

Examples

The following example shows the setting and retrieval of the configuration key for a control.

DictConfigurationKey dck; 
configurationKeyId cki; 
 
// objCtrl previously assigned. 
// Assign a configuration key to the control. 
objCtrl.configurationKey(configurationkeynum(BankDeposit)); 
 
// Retrieve the configuration key ID from the control. 
cki = objCtrl.configurationKey(); 
if (cki != 0) 
{ 
    dck = new DictConfigurationKey(cki); 
    if (dck) 
    { 
    print strfmt("Configuration Key ID: %1 Configuration Key Name: %2", 
                  cki, 
                  dck.name()); 
    } 
}

See Also

FormComboBoxControl Class

Best Practices for Configuration and Security Keys

DictConfigurationKey Class

FormComboBoxControl.configurationKeyEx Method