Sort.locale

Note:

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

Property Description	The locale of the sort.
Type	query.Operator (read-only)
Module	N/workbook Module
Parent Object	workbook.Sort
Sibling Object Members	Sort Object Members
Since	2020.2

Errors

Error Code	Thrown If
READ_ONLY_PROPERTY	You attempted to set this property.
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 Sort.locale in a TableDefinition
var myWorkbook = workbook.load({
    id: myWorkbookId
});
log.audit({
    title: 'Sort.locale = ',
    details: myWorkbook.tableDefinitions[0].columns[0].sort.locale
});
...
// Add additional code 

          

Related Topics

workbook.Sort

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices