Record.cancelLine(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description

Cancels the currently selected line on a sublist.

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

Returns

The record.Record object that called the method.

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.

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

2015.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/record Module Script Samples.

          // Add additional code
...
objRecord.cancelLine({
    sublistId: 'item'
});
...
// Add additional code 

        

Related Topics

record.Record
N/record Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices