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

EditBox.Password

The EditBox Control Object that is returned by the AddEditBox function has a Password property. The Password property allows the Edit Box to hide the characters that are entered in the Edit Box—each character is displayed as an asterisk. This is useful for password fields, where the password needs to be entered but has to be hidden from view.

Syntax

ControlObject.Password = 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 hide characters (use an asterisk in place of each character).

The Password property can only be used with Edit Boxes that have 1 line. Multiple lines of password text are not supported.

Arguments

Value {Boolean}

If set to True (1), the Edit box uses asterisks; if set to False (0) it does not hide the characters.

Returns

Boolean

Example:

EditBox1.Password = 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 use asterisks.

ClearSCADA 2015 R2