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

EditBox.ReadOnly

The EditBox Control Object that is returned by the AddEditBox function has a ReadOnly property. The ReadOnly property allows you to restrict the Edit Box so that it can only display a value - users are unable to alter or add to the value in the Edit Box.

Syntax

ControlObject.ReadOnly = 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 the Edit Box to be read only or read/write.

Arguments

Value {Boolean}

If set to True (1), the Edit box is read only; if set to False (0) it is read/write.

Returns

Boolean

Example:

EditBox1.ReadOnly = True

Where:

  • EditBox1 is the name of the variable that stores the EditBox Control Object returned by the AddEditBox function
  • True is the boolean value that sets the Edit Box to read only.

ClearSCADA 2015 R2