readOnly
Type: Boolean
Availability: Read or write at any time
The readOnly property specifies whether a control is read-only for user input.
For a CheckBox control, if the value of the readOnly property is true, the control does not respond to mouse or keyboard actions. Its state can be changed only from logic.
For a TextBox and JadeEditMask controls, the control can be tabbed to, responds to user mouse actions, and text can be selected, but keyboard input is ignored. For a text box or edit mask control on a Web page, the control is converted to static text if the value of this property is true.
For a Table control, if the value of the readOnly property is true:
-
No key events are processed
-
The user can still change cells that have the inputType property set
-
No select or select clear occurs when a mouse is clicked in a cell
-
No focus rectangle is displayed
-
Clicking a cell still causes a rowColumnChg event
Set the userInputEnabled property to false if you want the value of the inputType or the cellControl property ignored for all cells.
The settings of the readOnly property are listed in the following table.
| Value | Description |
|---|---|
| false | Control responds to mouse and keyboard actions (the default) |
| true | Control does not respond to mouse and keyboard actions |
Setting the readOnly property to true enables a check box to be used to indicate the state of an option without the user being able to directly change that option.
The readOnly property of the JadeRichText control specifies whether the contents of the control can be updated (that is, whether user input is accepted). A double‑click action is ignored in a read‑only JadeRichText control only if an object is selected. Double‑clicking a hyperlink in a read‑only JadeRichText control processes the URL request (that is, the control can be tabbed to, respond to user mouse actions, and text can be selected, but keyboard input is ignored). The default value of false indicates that the control responds to both mouse and keyboard actions.
The readOnly property of the JadeTextEdit control specifies whether the text editor is read-only for user input. The EVENTTYPE_ALTERREADONLY notification occurs on each attempt by the user or the application to change the text editor contents.
Assigning to the JadeTextEdit class text property is permitted when the value of the readOnly property is true but all other user and programmatic changes are ignored.
