1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/record Module
  6. record.Record
  7. Record.setValue(options)

Record.setValue(options)

Method Description

Sets the value of a field.

(dynamic and standard mode — see SuiteScript 2.x Standard and Dynamic Modes)

Note:

For rate and ratehighprecisionfields, use the Record.setText(options) method to set a string value with a "%".

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.fieldId

string

required

The internal ID of a standard or custom body field.

See, Finding Internal IDs of Record Fields.

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 and Radio fields accept string values.

  • Select fields accept string and number values.

  • Multi-Select fields accept arrays of string or number values.

  • Checkbox fields accept boolean values.

  • Date and DateTime fields accept Date values.

  • Integer, Float, Currency and Percent fields accept number values.

  • Inline HTML fields accept strings. Strings containing HTML tags are represented as HTML entities in UI, this is demonstrated in Syntax section below.

For rate and ratehighprecisionfields, use the Record.setText(options) method to set a string value with a "%".

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

The following code sample shows the syntax for INLINEHTML fields and what is returned.

          ...
objRececord.setValue(inlineHtmlFieldId, '<i>foo</i>'); // Returns text in cursive.
objRececord.getValue(inlineHtmlFieldId); // Returns '<i>foo</i>'
objRececord.getText(inlineHtmlFieldId); // Returns 'foo'
...

Related Topics

General Notices