Form.addPageLink(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description	Adds a link to a form. Note: You cannot choose where the page link appears.
Returns	void
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.title	string	required	The text label for the link.	2015.2
options.type	string	required	The type of page link to add. Use the serverWidget.FormPageLinkType enum to set the value.	2015.2
options.url	string	required	The URL for the link.	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.addPageLink({
    type : serverWidget.FormPageLinkType.CROSSLINK,
    title : 'NetSuite',
    url : 'http://www.netsuite.com'
})
...
//Add additional code 

        

Related Topics

serverWidget.Form

N/ui/serverWidget Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices