bindDataToCollectionControls

Method Type

JavaScript

Description

Binds the specified values to the specified form control.

You can use this method for these form controls that support only name/value pair lookup types:

  • Check Box Check Box icon
  • Radio Button Radio Button icon
  • Drop-Down List Drop-Down List icon
  • Drop-Down List Drop-Down List icon
  • List Box List Box icon
  • Auto-Suggest Auto-Suggest icon
  • Auto-Suggest Auto-Suggest icon
  • Multi-Select List Box Multi-Select List Box icon

Parameters

The method input is an object with these parameters, and a callback function.

Field NameDefinition

fieldId

Function:
Specifies the internal name for the form control to change.
Type
string
Accepted Values:
The internal name of your form control.

value

Function:
The value for an array of objects to bind to the specified form control.
Type
object
Accepted Values:
An array of objects.

Output

A result object that gives the status, data, and error details.

Field NameDefinition

isSuccess

Function:
Specifies whether a pop-up shows when the method completes successfully.
Type
bool
Accepted Values:
  • True - The method was successful.
  • False - The method was not successful.

data

Function:
Holds an empty object.

error

Function:
Specifies an error message if an error occurs.
Type
string
Accepted Values:
The contents of an error message.

Example

var options = {};
  options.fieldId = 'DropdownList1';
  
  //Specifies the value as an array of objects as name/value pair.
  options.value = [{Name: 'Option 1', Value: 'Option 1'}, 
                 {Name: 'Option 2', Value: 'Option 2'}];
  
  eFormHelper.bindDataToCollectionControls(options, function(result) 
    { 
    if (result.isSuccess) //Checks if the method completes successfully and 
                               returns a response.
      { 
        console.log (result.data); //Logs the data and displays an array of 
                                        variable names and values.
      }
    else 
      {
        console.log(result.error); //Logs the error and error description, if any.
      }
});

Supported Versions

AgilePoint NX v7.0 Software Update 1 and higher

Other Examples

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.