You are here: Core Reference > Coding > Scripting > EditBox.WordWrap

EditBox.WordWrap

The EditBox Control Object that is returned by the AddEditBox function has a WordWrap property. The WordWrap property determines whether the value in the Edit Box wraps whole words onto the next line in the box.

Syntax

ControlObject.WordWrap = Value

Where ControlObject. is the name of the variable (declared in your script) that is used to store the EditBox Control Object that is returned by the AddEditBox function.

Description

Sets word wrapping for the Edit Box.

Word wrapping is only applicable if the Edit Box is set to have multiple lines.

Arguments

Value {Boolean}

If set to True (1), the Edit box has uses word wrapping; if set to False (0) it does not use word wrapping.

Returns

Boolean

Example:

EditBox1.WordWrap = 1

Where:

  • EditBox1 is the name of the variable that stores the EditBox Control Object returned by the AddEditBox function
  • 1 sets the Edit Box to use word wrapping.

ClearSCADA 2015 R2