setFieldsValues

Method Type

JavaScript

Description

Sets the values for more than one form control.

Parameters

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

Field NameDefinition

id
Function:
Specifies the internal name of the form control to set the value.
Type
string
Accepted Values:
The internal name of your form control.

value
Function:
The target value for the form control.
Type
The data type of the target form control.
Accepted Values:
A valid value for the target form control.

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 a value of the specified form control.

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

Example

var options = {};
// Sets the values for more than one form control.
// The Number1 and Date1 are the internal names of the form controls.
options.fields = [{
    id: 'Number1', 
    value: '0112345678'
  }, 
  {
    id: 'Date1', 
    value: '01/09/2023'
}]; 

// Set the values for all rows in a Subform form control.
// The Subform1 is an internal name of the Subform form control.
// The Number1 and Date1 are the internal names of the form controls.
// The Number1 and Date1 controls exist in the Subform1 form control.
// The value Subform1/Number1 shows the path of Number1.
// The value Subform1/Date1 shows the path of Date1.
// You can also use this format:
// options.fields = [{
    // id: 'Subform1/Number1', 
    // value: '0112345678'
  // }, 
  // {
    // id: 'Subform1/Date1', 
    // value: '01/09/2023'
}]; 

// Alternatively, you can specify rowIndex as an asterisk '*' 
// to set the values for all rows in a Subform1 form control.
// options.fields = [{
    // id:'Subform1/Number1: [*]', 
    // value: '0112345678'
  // }, 
  // {
    // id: 'Subform1/Date1: [*], 
    // value: '01/09/2023'
}]; 

// You can specify the row number to set 
// the values for specific rows 
// in a Subform1 form control.
// options.fields = [{
    // id: 'Subform1/Number1: [rowindex]', 
    // value: '0112345678'
  // },
  // {
    // id: 'Subform1/Date1: [rowindex]', 
    // value: '01/09/2023'
}];
		
eFormHelper.setFieldsValues(options, function (result)
{
  // Checks if the method is successful.
  if (result.isSuccess) 
      
  {
    // Logs the data that has the empty object.
    console.log(result.data); 
  }
  else 
    {
      // Logs errors and error descriptions.
      console.log(result.error); 
    }
});

Supported Versions

AgilePoint NX v8.0 Software Update 2 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.