Form.addSubtab(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description	Adds a subtab to a form. Note: To enable your subtab to appear on your form, there must be at least one object assigned to the subtab. Otherwise, the subtab will not appear. Note: If you have less than two subtabs on your form, the subtab will not appear. Instead the fields assigned to the tab will appear at the bottom of the form.
Returns	serverWidget.Tab object
Supported Script Types	SuiteScript 2.x Suitelet Script Type and SuiteScript 2.x User Event Script Type (beforeLoad(context))
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 name of the subtab. The internal ID must be in lowercase, contain no spaces. If you are adding the subtab to an existing page, include the prefix custpage. For example, if you add a subtab that appears as Purchase Details, the subtab internal ID should be something similar to custpage_purchasedetails or custpage_purchase_details.	2015.2
options.label	string	required	The label for this subtab.	2015.2
options.tab	string	optional	The tab under which to display this sublist. If empty, the sublist is added to the main tab.	2015.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/ui/serverWidget Module Script Samples.

          //Add additional code 
...
var form = serverWidget.createForm({
    title : 'Simple Form'
});
form.addSubtab({
    id : 'subtabid',
    label : 'Subtab'
});
...
//Add additional code 

        

Related Topics

serverWidget.Form

N/ui/serverWidget Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices