Field.updateBreakType(options)

Method Description

Updates the break type of the field. Set this value using the FieldBreakType enum The break type is used to add a break in flow layout for the field.

Returns

serverWidget.Field object

Supported Script Types

SuiteScript 2.x Suitelet Script Type and SuiteScript 2.x User Event Script Type (beforeLoad(context))

Governance

None

Module

N/ui/serverWidget Module

Since

2016.1

Parameters
Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

Since

options.breakType

string

required

The break type of the field. Set this value using the serverWidget.FieldBreakType enum

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.updateBreakType({
    breakType : serverWidget.FieldBreakType.STARTCOL
});
...
//Add additional code 

        

Related Topics

General Notices