serverWidget.FieldBreakType

Note:

JavaScript does not include an enumeration type. The SuiteScript 2.x documentation uses the term enumeration (or enum) to describe a plain JavaScript object with a flat, map-like structure. In this object, each key points to a read-only string value.

Enum Description

Holds the string values for supported field break types. This enum is used to set the value of the breakType parameter when Field.updateBreakType(options) is called.

Module

N/ui/serverWidget Module

Sibling Module Members

N/ui/serverWidget Module Members

Since

2015.2

Values

Value	Description
`NONE`	This is the default value for field break type.
`STARTCOL`	This value moves the field into a new column. Additionally, it disables automatic field balancing if set on any field.
`STARTROW`	This value places a field located outside of a field group on a new row. This value only works on fields with a Field Layout Type set to OUTSIDE, OUTSIDEABOVE or OUTSIDEBELOW. For more information, see serverWidget.FieldLayoutType and Field.updateLayoutType(options).

Value

Description

NONE

This is the default value for field break type.

STARTCOL

This value moves the field into a new column. Additionally, it disables automatic field balancing if set on any field.

STARTROW

This value places a field located outside of a field group on a new row. This value only works on fields with a Field Layout Type set to OUTSIDE, OUTSIDEABOVE or OUTSIDEBELOW.

For more information, see serverWidget.FieldLayoutType and Field.updateLayoutType(options).

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_text',
    type : serverWidget.FieldType.TEXT,
    label : 'Text'
});

field.updateLayoutType({
    layoutType: serverWidget.FieldLayoutType.OUTSIDE
});

field.updateBreakType({
    breakType : serverWidget.FieldBreakType.STARTROW
});
...
//Add additional code

Values

Syntax

Related Topics