Workbook.description

Note:

The content in this help topic applies to SuiteScript 2.x.

Property Description	The description of the workbook. This is set when you create a workbook.
Type	string
Module	N/workbook Module
Parent Object	workbook.Workbook
Sibling Object Members	Workbook Object Members
Since	2020.2

Errors

Error Code	Thrown If
WRONG_PARAMETER_TYPE	The value for this property is not a string.

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

            // Add additional code
...
// View a workbook's description
var myWorkbook = workbook.load({
    id: myWorkbookId 
});
log.audit({
    title: 'Workbook.description = ',
    details: myWorkbook.description
});
...
// Add additional code 

          

Related Topics

workbook.Workbook

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices