Portlet Object

Portlet objects are used to encapsulate scriptable dashboard portlets. They are automatically passed to the render(params) entry point by NetSuite. For more information, see render(params).

Simple Form Portlet Object Members

These members are only available to Form Portlet objects.

Member Type	Name	Return Type / Value Type	Description
Method	Portlet.addField(options)	serverWidget.Field	Adds a field to the form.
	Portlet.setSubmitButton(options)	serverWidget.Button	Adds a submit button to the form.
Property	Portlet.clientScriptFileId	number or string	The script file ID to be used in the portlet. Can be in either numerical or string format.
	Portlet.clientScriptModulePath	string	The script path to be used in the portlet.
	Portlet.title	string	The title of the portlet.

Inline HTML Portlet Object Members

These members are only available to HTML Portlet objects.

Member Type	Name	Return Type / Value Type	Description
Property	Portlet.html	string	The complete HTML contents of the portlet.
	Portlet.title	string	The title of the portlet.

Links and Indents Portlet Object Members

These members are only available to Links Portlet objects.

Member Type	Name	Return Type / Value Type	Description
Method	Portlet.addLine(options)	Object	Adds a line to the portlet.
Property	Portlet.title	string	The title of the portlet.

Simple List Portlet Object Members

These members are only available to List Portlet objects.

Member Type	Name	Return Type / Value Type	Description
Method	Portlet.addColumn(options)	serverWidget.ListColumn	Adds a column to the portlet.
	Portlet.addEditColumn(options)	serverWidget.ListColumn	Adds an Edit or Edit/View column to the portlet.
	Portlet.addRow(options)	Object	Adds a row to the portlet.
	Portlet.addRows(options)	Object	Adds multiple rows to the portlet.
Property	Portlet.title	string	The title of the portlet.

Related Topics

SuiteScript 2.x Portlet Script Entry Points and API

render(params)

General Notices