Workbook.description
Property Description |
The description of the workbook. This is set when you create a workbook. |
Type |
string |
Module |
|
Parent Object |
|
Sibling Object Members |
|
Since |
2020.2 |
Errors
Error Code |
Thrown If |
---|---|
|
The value for this property is not a string. |
Syntax
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. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.
// 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