Class: nlobjSubList

nlobjSubList

new nlobjSubList() → {nlobjSubList}

Return a new instance of nlobjSubList used for scriptable sublist (sublist). This object is READ-ONLY except for instances created via the UI Object API using Suitelets or beforeLoad user events.
Source:
Returns:
Type
nlobjSubList

Methods

addButton(name, label, script) → {nlobjButton}

add a button to this sublist.
Parameters:
Name Type Description
name string button name
label string button label
script string button script (function name)
Since:
  • 2008.2
Source:
Returns:
Type
nlobjButton

addField(name, type, label, source) → {nlobjField}

add a field (column) to this sublist.
Parameters:
Name Type Argument Description
name string field name
type string field type
label string field label
source string, int <optional>
script ID or internal ID for source list used for this select field
Since:
  • 2008.2
Source:
Returns:
Type
nlobjField

addMarkAllButtons()

add "Mark All" and "Unmark All" buttons to this sublist of type "list".
Since:
  • 2008.2
Source:

addRefreshButton() → {nlobjButton}

add "Refresh" button to sublists of type "staticlist" to support manual refreshing of the sublist (without entire page reloads) if it's contents are very volatile
Since:
  • 2009.2
Source:
Returns:
Type
nlobjButton

getLineItemCount(group)

Return the number of lines in a sublist.
Parameters:
Name Type Description
group string sublist name
Since:
  • 2010.1
Source:

setDisplayType(type)

set the displaytype for this sublist: hidden|normal. This method is only supported on scripted or staticlist sublists via the UI Object API
Parameters:
Name Type Description
type string
Since:
  • 2008.2
Source:

setHelpText(help)

set helper text for this sublist. This method is only supported on sublists via the UI Object API
Parameters:
Name Type Description
help string
Since:
  • 2008.2
Source:

setLabel(label)

set the label for this sublist. This method is only supported on sublists via the UI Object API
Parameters:
Name Type Description
label string
Since:
  • 2008.2
Source:

setLineItemMatrixValue(field, line, column, value) → {void}

set the value of a matrix cell in this sublist.
Parameters:
Name Type Description
field string matrix field name
line int line number (1-based)
column int matrix column index (1-based)
value string matrix field value
Since:
  • 2009.2
Source:
Returns:
Type
void

setLineItemValue(field, line, value)

set the value of a cell in this sublist.
Parameters:
Name Type Description
field string sublist field name
line int line number (1-based)
value string sublist value
Since:
  • 2008.2
Source:

setLineItemValues(values)

set values for multiple lines (Array of nlobjSearchResults or name-value pair Arrays) in this sublist. Note that this method is only supported on scripted sublists via the UI Object API
Parameters:
Name Type Description
values string[][], nlobjSearchResult[]
Since:
  • 2008.2
Source:

setUniqueField(fldnam) → {nlobjField}

designate a field on sublist that must be unique across all lines (only supported on sublists of type inlineeditor, editor).
Parameters:
Name Type Description
fldnam string the name of a field on this sublist whose value must be unique across all lines
Since:
  • 2009.2
Source:
Returns:
Type
nlobjField