workbook.createFieldContext(options)

Note:

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

Method Description	Creates a field context for a table definition column.
Returns	workbook.FieldContext
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/workbook Module
Sibling Module Members	N/workbook Module Members
Since	2020.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.name	string	required	The name of the field context.
options.parameters	Object	optional	The parameters for the field context, as a key: value pair.

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
...
// Create a basic FieldContext
var myFieldContext = workbook.createFieldContext({
    name: 'My Field Context'
});

// Create a complete FieldContext
var myFieldContext = workbook.createFieldContext({
    name: 'My Field Context',
    parameters: {
        parm1: 'ABC'
    }
});
...
// Add additional code 

          

Related Topics

N/workbook Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices