List.addPageLink(options)

Method Description

Adds a link to a list.

Returns

serverWidget.List (it return itself)

Supported Script Types

Suitelets

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.title`	string	required	The text label for the link.	2015.2
`options.type`	string	required	The type of page link to add. Set this value using the serverWidget.FormPageLinkType enum.	2015.2
`options.url`	string	required	The URL for the link.	2015.2

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.

Set this value using the serverWidget.FormPageLinkType enum.

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 list = serverWidget.createList({
    title : 'Simple List'
});
list.addPageLink({
    title : 'NetSuite',
    type : serverWidget.FormPageLinkType.CROSSLINK,
    url : 'http://www.netsuite.com'
});
... 
//Add additional code

Parameters

Syntax

Related Topics