CurrentRecord.setText(options)

Method Description

Sets the value of the field by a text representation.

Sets a string value with a "%" for rate and ratehighprecision fields.

Returns

currentRecord.CurrentRecord

Supported Script Types

Client scripts

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

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.fieldId`	string	required	The internal ID of a standard or custom body field. See Finding Internal IDs of Record Fields.	2016.2
`options.text`	string	required	The text to change the field value to.	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

Parameter

Type

Required / Optional

Description

Since

options.fieldId

string

required

The internal ID of a standard or custom body field.

See Finding Internal IDs of Record Fields.

2016.2

options.text

string

required

The text to change the field value to.

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
`SSS_MISSING_REQD_ARGUMENT`	A required argument is missing or undefined.

Error Code

Thrown If

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.setText({
    fieldId: 'item',
    text: 'value',
    ignoreFieldChange: true,
    forceSyncSourcing: true
});
... 
//Add additional code

Parameters

Errors

Syntax

Related Topics