CurrentRecord.cancelLine(options)

Method Description

Cancels the currently selected line on a sublist.

Returns

The currentRecord.CurrentRecord object that called the method.

Governance

None

Module

N/currentRecord Module

Sibling Object Members

CurrentRecord Object Members

Parent Object

currentRecord.CurrentRecord

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.

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

2016.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/currentRecord Module Script Samples.

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

        

Related Topics

General Notices