1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/currentRecord Module
  6. currentRecord.CurrentRecord
  7. CurrentRecord.findMatrixSublistLineWithValue(options)

CurrentRecord.findMatrixSublistLineWithValue(options)

Method Description

Returns the line number of the first instance where a specified value is found in a specified column of the matrix.

Returns

number

Supported Script Types

Client scripts

For more information, see SuiteScript 2.x Script Types.

Governance

None

Module

N/currentRecord Module

Parent Object

currentRecord.CurrentRecord

Sibling Object Members

CurrentRecord Object Members

Since

2016.2
Parameters
Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

Since

options.sublistId

string

required

The internal ID of the sublist.

This value is displayed in the Records Browser. For more information, see Working with the SuiteScript Records Browser.

2016.2

options.fieldId

string

required

The ID of the matrix field.

See Finding Internal IDs of Record Fields.

2016.2

options.value

number

required

The value to search for.

2016.2

options.column

number

required

The column number of the field.

2016.2
Errors

Error Code

Thrown If

SSS_INVALID_SUBLIST_OPERATION

A required argument is invalid or the sublist is not editable.

SSS_MISSING_REQD_ARGUMENT

A required argument is missing or undefined.
Syntax
Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/currentRecord Module Script Samples.

          //Add additional code 
...
var lineNumber = objRecord.findMatrixSublistLineWithValue({
    sublistId: 'item'
});
... 
//Add additional code

Related Topics

General Notices