Form.addButton(options)

Method Description

Adds a button to a form.

Returns

serverWidget.Button object

Supported Script Types

Suitelets

User event scripts -beforeLoad entry point

For more information, see SuiteScript 2.x Script Types.

Governance

None

Module

N/ui/serverWidget Module

Since

2015.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description	Since
`options.id`	string	required	The internal ID of the button. If you are adding the button to an existing page, the internal ID must be in lowercase, contain no spaces, and include the prefix `custpage`. For example, if you add a button that appears as Update Order, the button internal ID should be something similar to custpage_updateorder.	2015.2
`options.label`	string	required	The label for this button.	2015.2
`options.functionName`	string	optional	The function name to call when clicking this button. The function name must be the name of the method defined in a custom module client script. For an example, see Update Fields on Current Record using a Custom Module Script and a User Event Script. Important: Custom module client scripts with the specified function must be attached to the form. To learn more, see Form.clientScriptModulePath and Form.clientScriptFileId.	2016.1

Parameter

Type

Required / Optional

Description

Since

options.id

string

required

The internal ID of the button.

If you are adding the button to an existing page, the internal ID must be in lowercase, contain no spaces, and include the prefix custpage. For example, if you add a button that appears as Update Order, the button internal ID should be something similar to custpage_updateorder.

2015.2

options.label

string

required

The label for this button.

2015.2

options.functionName

string

optional

The function name to call when clicking this button.

The function name must be the name of the method defined in a custom module client script. For an example, see Update Fields on Current Record using a Custom Module Script and a User Event Script.

Important:

Custom module client scripts with the specified function must be attached to the form. To learn more, see Form.clientScriptModulePath and Form.clientScriptFileId.

2016.1

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

          //Add additional code 
...
var form = serverWidget.createForm({
    title : 'Simple Form'
});
  
form.addButton({
    id : 'buttonid',
    label : 'Test'
});
...
//Add additional code

Parameters

Syntax

Related Topics