FormListControl.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 identifier 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 a call to the configurationKey method to assign the Bank configuration key to the form list control.

static void createForm2(Args _args) 
{ 
    Args args; 
    Form form; 
    FormRun formRun; 
    FormBuildDesign formBuildDesign; 
    FormBuildDataSource formBuildDataSource; 
    FormBuildListControl formBuildListControl; 
    FormListControl formListControl; 
    int idx4; 
    DictTable dictTable; 
    CustTable custTable; 
    configurationKeyId ID; 
    // Create the form header. 
    form = new Form(); 
    // Add data sources to the form. 
    dictTable = new DictTable(tableNum(custTable)); 
    formBuildDataSource = form.addDataSource(dictTable.name()); 
    formBuildDataSource.table(dictTable.id()); 
    // Create the form design. 
    formBuildDesign = form.addDesign("Design"); 
    formBuildDesign.caption("myForm"); 
    // Add a form list control. 
    formBuildListControl = 
 formBuildDesign.addControl(FormControlType::ListView,"List"); 
    idx4 = formBuildListControl.id(); 
    args = new Args(); 
    args.object(form); 
    // Create the run time-form. 
    formRun = classfactory.formRunClass(args); 
    formRun.run(); 
    formRun.detach(); 
    formListControl = formRun.control(idx4); 
    ID = formListControl.configurationKey(configurationKeyNum(Bank)); 
}

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

A configurationKeyId system data type that specifies the configuration key ID.

Returns

Int32