CurrentRecord.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. Sets a numeric value for rate and ratehighprecision fields. This method is not available for standard records.
Returns	currentRecord.CurrentRecord
Supported Script Types	Client scripts For more information, see SuiteScript 2.x Client Script Type.
Governance	None
Module	N/currentRecord Module
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 that contains the matrix. 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 internal ID of the matrix field. See How to Find a Field's Internal ID.	2016.2
options.column	number	required	The column number for the field.	2016.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.	2016.2
options.ignoreFieldChange	boolean	optional	If set to true, the field change and the secondary event is ignored. By default, this value is false.	2016.2
options.forceSyncSourcing	boolean	optional	Indicates whether to perform field sourcing synchronously. This parameter can be used to alleviate a timing situation that may occur in some browsers when fields are sourced. For some browsers, some APIs are triggered without waiting for the field sourcing to complete which could cause incorrect results. If set to true, sources dependent field information for empty fields synchronously. Defaults to false – dependent field values are not sourced synchronously. See Perform Field Sourcing Synchronously.	2019.1

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/currentRecord 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

currentRecord.CurrentRecord

N/currentRecord Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices