workbook.TextDecorationLine

Note:

JavaScript does not include an enumeration type. The SuiteScript 2.x documentation uses the term enumeration (or enum) to describe a plain JavaScript object with a flat, map-like structure. In this object, each key points to a read-only string value.

Enum Description

Holds string values for text decoration line types, such as underline and strikethrough. Used to set the value for the options.txtDecorationLine parameter of the workbook.createStyle(options) method.

Module

N/workbook Module

Sibling Module Members

N/workbook Module Members

Since

2021.2

Values

Value
`LINE_THROUGH`
`NONE`
`OVERLINE`
`UNDERLINE`

Value

LINE_THROUGH

NONE

OVERLINE

UNDERLINE

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. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.

            // Add additional code
...
// use when creating a style
var newStyle = workbook.createStyle({
    textAlign: workbook.TextAlign.CENTER,
    textDecorationColor: workbook.Color.YELLOW,
    textDecorationLine: workbook.TextDecorationLine.UNDERLINE,
    textDecorationsStyle: workbook.TextDecorationStyle.WAVY 
});
...
// Add additional code

General Notices