Sublist.addButton(options)
|
Method Description |
Adds a button to a sublist. |
|
Returns |
|
|
Supported Script Types |
SuiteScript 2.x Suitelet Script Type and SuiteScript 2.x User Event Script Type (beforeLoad(context)) |
|
Governance |
None |
|
Module |
|
|
Since |
2015.2 |
Parameters
The options parameter is a JavaScript object.
|
Parameter |
Type |
Required / Optional |
Description |
|---|---|---|---|
|
|
string |
required |
The internal ID name of the button. The internal ID must be in lowercase and without spaces. |
|
|
string |
required |
The label for the button. |
|
|
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 examples, see N/currentRecord Samples.
Important:
Custom module client scripts with the specified function must be attached to the form. To learn more, see Form.clientScriptModulePath and Form.clientScriptFileId. |
Syntax
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'
});
var sublist = form.addSublist({
id : 'sublist',
type : serverWidget.SublistType.INLINEEDITOR,
label : 'Inline Editor Sublist'
});
sublist.addButton({
id : 'buttonid',
label : 'Test'
});
...
//Add additional code