Record.setCurrentMatrixSublistValue(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description	Sets the value for the line currently selected in the matrix. (dynamic mode only — see SuiteScript 2.x Standard and Dynamic Modes) Sets a string value with a "%" for rate and ratehighprecision fields.
Returns	record.Record
Supported Script Types	Client and server scripts For more information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/record Module
Sibling Object Members	Record Object Members
Since	2015.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 that contains the matrix. This value is displayed in the Records Browser. For more information, see Working with the SuiteScript Records Browser.	2015.2
options.fieldId	string	required	The internal ID of the matrix field. See, How to Find a Field's Internal ID.	2015.2
options.column	number	required	The column number for the field. Note that column indexing begins at 0 with SuiteScript 2.0.	2015.2
options.value	number | Date | string | array | boolean	required	The value to set the field to. The value type must correspond to the field type being set. For example: Text, Radio and Select fields accept string values. Checkbox fields accept boolean values. Date and DateTime fields accept Date values. Integer, Float, Currency and Percent fields accept number values.	2015.2
options.ignoreFieldChange	boolean	optional	If set to true, the field change and the secondary event is ignored. By default, this value is false.	2015.2

Errors

Error Code	Thrown If
INVALID_FLD_VALUE	The options.value type does not match the field type.
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/record Module Script Samples.

          // Add additional code
...
objRecord.setCurrentMatrixSublistValue({
    sublistId: 'item',
    fieldId: 'item',
    column: 3,
    value: false,
    ignoreFieldChange: true,
    forceSyncSourcing: true
});
...
// Add additional code 

        

Related Topics

record.Record

N/record Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices