Class: nlobjForm

nlobjForm

new nlobjForm() → {nlobjForm}

Return a new instance of nlobjForm used for scriptable form page.
Source:
Returns:
Type
nlobjForm

Methods

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

add a button to this form.
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, tab) → {nlobjField}

add a field (nlobjField) to this form and return it.
Parameters:
Name Type Argument Description
name string field name
type string field type
label string <optional>
field label
source string, int <optional>
script ID or internal ID for source list (select and multiselects only) -or- radio value for radio fields
tab string <optional>
tab name that this field will live on. If empty then the field is added to the main section of the form (immediately below the title bar)
Since:
  • 2008.2
Source:
Returns:
Type
nlobjField

addFieldGroup(name, label, tab) → {nlobjFieldGroup}

add a field group to the form.
Parameters:
Name Type Description
name string field group name
label string field group label
tab
Since:
  • 2011.1
Source:
Returns:
Type
nlobjFieldGroup
add a navigation cross-link to the page.
Parameters:
Name Type Description
type string page link type: crosslink|breadcrumb
title string page link title
url string URL for page link
Since:
  • 2008.2
Source:

addResetButton(label) → {nlobjButton}

add a reset button to this form.
Parameters:
Name Type Argument Description
label string <optional>
label for this button. defaults to "Reset"
Since:
  • 2008.2
Source:
Returns:
Type
nlobjButton

addSubList(name, type, label, tab) → {nlobjSubList}

add a sublist (nlobjSubList) to this form and return it.
Parameters:
Name Type Argument Description
name string sublist name
type string sublist type: inlineeditor|editor|list|staticlist
label string sublist label
tab string <optional>
parent tab that this sublist lives on. If empty, it is added to the main tab
Since:
  • 2008.2
Source:
Returns:
Type
nlobjSubList

addSubmitButton(label) → {nlobjButton}

add a submit button to this form.
Parameters:
Name Type Argument Description
label string <optional>
label for this submit button. defaults to "Save"
Since:
  • 2008.2
Source:
Returns:
Type
nlobjButton

addSubTab(name, label, tab) → {nlobjTab}

add a subtab (nlobjTab) to this form and return it.
Parameters:
Name Type Argument Description
name string subtab name
label string subtab label
tab string <optional>
parent tab that this subtab lives on. If empty, it is added to the main tab.
Since:
  • 2008.2
Source:
Returns:
Type
nlobjTab

addTab(name, label) → {nlobjTab}

add a tab (nlobjTab) to this form and return it.
Parameters:
Name Type Description
name string tab name
label string tab label
Since:
  • 2008.2
Source:
Returns:
Type
nlobjTab

addTitleHtml(title)

set additional title Html. INTERNAL ONLY
Parameters:
Name Type Description
title string
Since:
  • 2008.2
Source:

getButton(name) → {nlobjButton}

get a button from this form by name.
Parameters:
Name Type Description
name string
Since:
  • 2009.2 add
Source:
Returns:
Type
nlobjButton

getField(name, radio) → {nlobjField}

return a field (nlobjField) on this form.
Parameters:
Name Type Argument Description
name string field name
radio string <optional>
if this is a radio field, specify which radio field to return based on radio value
Since:
  • 2008.2
Source:
Returns:
Type
nlobjField

getSubList(name) → {nlobjSubList}

return a sublist (nlobjSubList) on this form.
Parameters:
Name Type Description
name string sublist name
Since:
  • 2008.2
Source:
Returns:
Type
nlobjSubList

getSubTab(name) → {nlobjTab}

return a subtab (nlobjTab) on this form.
Parameters:
Name Type Description
name string subtab name
Since:
  • 2008.2
Source:
Returns:
Type
nlobjTab

getTab(name) → {nlobjTab}

return a tab (nlobjTab) on this form.
Parameters:
Name Type Description
name string tab name
Since:
  • 2008.2
Source:
Returns:
Type
nlobjTab

insertField(field, nextfld) → {nlobjField}

insert a field (nlobjField) before another field (name).
Parameters:
Name Type Description
field nlobjField the field object to insert
nextfld string the name of the field before which to insert this field
Since:
  • 2008.2
Source:
Returns:
Type
nlobjField

insertSubList(sublist, nextsublist) → {nlobjSubList}

insert a sublist (nlobjSubList) before another subtab or sublist (name).
Parameters:
Name Type Description
sublist nlobjSubList the sublist object to insert
nextsublist string the name of the sublist before which to insert this sublist
Since:
  • 2008.2
Source:
Returns:
Type
nlobjSubList

insertSubTab(subtab, nextsubtab) → {nlobjTab}

insert a subtab (nlobjTab) before another subtab or sublist (name).
Parameters:
Name Type Description
subtab nlobjTab the subtab object to insert
nextsubtab string the name of the subtab before which to insert this subtab
Since:
  • 2008.2
Source:
Returns:
Type
nlobjTab

insertTab(tab, nexttab) → {nlobjTab}

insert a tab (nlobjTab) before another tab (name).
Parameters:
Name Type Description
tab nlobjTab the tab object to insert
nexttab string the name of the tab before which to insert this tab
Since:
  • 2008.2
Source:
Returns:
Type
nlobjTab

setFieldValues(values)

set the values for all the fields on this form.
Parameters:
Name Type Description
values Object Object containing field name/value pairs
Since:
  • 2008.2
Source:

setScript(script)

set the Client Script definition used for this page.
Parameters:
Name Type Description
script string, int script ID or internal ID for global client script used to enable Client SuiteScript on page
Since:
  • 2008.2
Source:

setTitle(title)

set the page title.
Parameters:
Name Type Description
title string
Since:
  • 2008.2
Source: