FormTreeControl.configurationKey Method

Definition

Namespace:

Dynamics.AX.Application

Assembly:

Overloads

configurationKey()	Gets or sets the configuration key that is assigned to the control.
configurationKey(Int32)

configurationKey()

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

public:
 override int configurationKey();

public override int configurationKey ();

override this.configurationKey : unit -> int

Public Overrides Function configurationKey () As Integer

Returns

Int32

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()); 
    } 
}

configurationKey(Int32)

public:
 override int configurationKey(int _value);

public override int configurationKey (int _value);

override this.configurationKey : int -> int

Public Overrides Function configurationKey (_value As Integer) As Integer

Parameters

_value

Int32

The ID of the configuration key to assign to the control.

Returns

Int32