Field.setHelpText(options)

Method Description

Sets the help text for the field.

When the field label is clicked, a popup displays the help text defined using this method.

Returns

The serverWidget.Field object

Supported Script Types

Suitelets

User event scripts -beforeLoad entry point

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.help`	string	required	The text in the field help popup.	2015.2
`options.showInlineForAssistant`	Boolean	optional	If set to `true`, the field help will display inline below the field on the assistant, and in a field help popup. The default value is `false`, which means the field help appears in a popup when the field label is clicked and does not appear inline. Note: The `inline` parameter is available only to serverWidget.Field objects that have been added to serverWidget.Assistant objects.	2015.2

Parameter

Type

Required / Optional

Description

Since

options.help

string

required

The text in the field help popup.

2015.2

options.showInlineForAssistant

Boolean

optional

If set to true, the field help will display inline below the field on the assistant, and in a field help popup.

The default value is false, which means the field help appears in a popup when the field label is clicked and does not appear inline.

Note:

The inline parameter is available only to serverWidget.Field objects that have been added to serverWidget.Assistant objects.

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'
});
var field = form.addField({
    id : 'custpage_textfield',
    type : serverWidget.FieldType.TEXT,
    label : 'Text'
});
field.setHelpText({
    help : "Help Text Goes Here."
});
...
//Add additional code

Parameters

Syntax

Related Topics