FormControl.configurationKey Method

public:
 virtual int configurationKey();

public virtual int configurationKey ();

abstract member configurationKey : unit -> int
override this.configurationKey : unit -> int

Public Overridable Function configurationKey () As Integer

Returns

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.

The following example shows how to set and retrieve 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()); 
    } 
}

public:
 virtual int configurationKey(int _value);

public virtual int configurationKey (int _value);

abstract member configurationKey : int -> int
override this.configurationKey : int -> int

Public Overridable Function configurationKey (_value As Integer) As Integer

Parameters

Returns