deleteRowsFromSubForm

Description

Deletes one or more rows from a subform. This method can be used for a primary (top-level) subform or a nested subform.

Parameters

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

Output

A result object that gives the status and error details.

Example: Subform

var options = {};

// The SubForm1 is an internal name of the Subform form control
options.fieldId = 'SubForm1';

// Specifies rowIndex as asterisk (*) to delete all rows, or 
// you can specify the row number separated by semicolons (;) to delete 
// specific rows. For example, '1,2'
options.rowIndex = '*'; 
// (or) options. rowIndex =  '1,2';

  eFormHelper.deleteRowsFromSubForm(options, function(result) 
    {
    
    //Checks if the method completes successfully and returns a response.
    if (result.isSuccess) 
     { 
     
        //Logs the data and shows an array of variable names and values.
        console.log (result.data); 
      }
    else 
      { 
      
        //Logs the error and error description, if any.
        console.log(result.error); 
      }
});

Example: Nested Subform

var options = {};
   
// Specifies rowIndex as asterisk '*' to delete all 'SubForm2' controls
// present inside 'SubForm1', or you can specify the row number 
// separated by semicolons (;) to delete specific 'SubForm2' control in given
// rows. For example, '1;2'

// The SubForm1 and SubForm2 are internal names of Subform controls. The
// SubForm2 is present inside the SubForm1. 
// The Subform1/Subform2 shows the path of subform2. 
options.fieldId = 'SubForm1/SubForm2:[*]';
// (or) options.fieldId = 'SubForm1/Subform2:[1;2]'

// Specifies rowIndex as asterisk (*) to delete all rows, or 
// you can specify the row number with separated by comma (,) to delete
// specific rows. For example, '1,2'
options.rowIndex = '*';
// (or) options.rowIndex = '1,2';

eFormHelper.deleteRowsFromSubForm(options, function(result) 
{
   
  // Checks if the method completes successfully and returns a response.
  if (result.isSuccess)
    
  {
    // Logs the data and shows an array of variable names and values.
    console.log (result.data);
  
  }
  else 
    { 
      
      // Logs the error and error description, if any.
      console.log(result.error); 
    }
});

Supported Versions

• AgilePoint NX v7.0 Software Update 1 and higher.
• Support for nested subforms is available in AgilePoint NX v8.0 and higher.

Other Examples

• (Example) Use Custom JavaScript in an eForm
• JavaScript Methods for eForm Builder - Examples for JavaScript methods that are available out-of-the-box (OOTB) in AgilePoint NX.