Sort.caseSensitive

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

Whether the sort is case sensitive.

This property is set during the execution of Query.createSort(options) and Component.createSort(options).

If a sort is case sensitive (and the sort direction is ascending), rows with column values that start with uppercase letters are listed before rows with column values that start with lowercase letters. If a sort is not case sensitive, uppercase and lowercase letters are treated the same. For example, the following list of items is sorted using a case-sensitive sort with a sort direction of ascending:

Banana
Orange
apple
grapefruit
kiwi

Here is the same list of items sorted using a regular (not case-sensitive) sort with a sort direction of ascending:

apple
Banana
grapefruit
kiwi
Orange

The default value of this property is false.

Type

boolean

Module

N/query Module

Parent Object

query.Sort

Sibling Object Members

Sort Object Members

Since

2018.2

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

            // Add additional code
...
var myCustomerQuery = query.create({ type: query.Type.CUSTOMER
}); myCustomerQuery.columns = [ myCustomerQuery.createColumn({ fieldId: 'entityid' })
]; myCustomerQuery.sort = [ myCustomerQuery.createSort({ column: myCustomerQuery.columns[0], ascending: false, caseSensitive: true, locale: query.SortLocale.EN_CA, nullsLast: false })
]; var theCaseSensitive = myCustomerQuery.sort[0].caseSensitive;
...
// Add additional code

Syntax

Related Topics