These two components display a standard edit box which is an area on the screen where a user can enter in data. The normal edit box allows only one line of text but allows editing directly on the page. The multiline edit box allows multiple lines to be entered, but this is done through a popup window that appears when the component is clicked.
Edit Box Properties:
Main:
OutputTarget: the channel or variable that will receive whatever is entered into the edit box when the operator clicks away from box or presses the Enter key. Note that if you assign an invalid value to a channel or variable that is declared numeric, NaN will be assigned.
Password: if enabled, any characters entered will display as *
Numeric: if enabled, only numeric characters can be entered. Also, if the edit box is empty, nothing will be submitted.
ReadOnly: if enabled, the edit box is readonly and won't accept edits. It is often easier to use the expCanInteract expression for this.
Format:
TextFormat, TextFormatPreset: the format (font etc.) of the text entered into the edit box.
TextBrush, TextBrushPreset: the brush (color) of the text entered into the edit box.
SelectionTextBrush, SelectionTextBrushPreset: the brush (color) of any text that is selected.
SelectionBackBrush, SelectionBackBrushPreset: the brush (color) of the background of any text that is selected.
FocusBorderBrush, FocusBorderBrushPreset: the brush (color) of the border when the component has focus (i.e. when typing on the keyboard enters characters into the component).
NotEnteredBackBrush, NotEnteredBackBrushPreset: the brush (color) used for the background if the value in the edit box does not match the current value of the OutputTarget. This will happen as the user is entering a new value, before they have submitted the changes.
ReadOnlyTextBrush, ReadOnlyTextBrushPreset: the brush (color) used for the text in the edit box when the edit box is marked ReadOnly. Note that expCanInteract does not affect this.
ReadOnlyBackBrush, ReadOnlyBackBrushPreset: the brush (color) used for the background of the edit box when the edit box is marked ReadOnly.
Common Properties:
This component includes all the common properties of components plus the background properties described in section 7.4.4.
Variables:
Contents, strContents: accessible from script. Provides direct access to the text currently displayed in the edit box. This is a read / write variable so you can change the contents of the edit box directly from script though that will not trigger the OnEditComplete event, nor update OutputTarget. You can force all edit boxes to update with the current value of OutputTarget by using the UpdateEdits() function described in section 7.14.
strContents is deprecated and included only for backwards compatibility. It is synonymous with Contents.
Events:
OnEditComplete: called when the operator has finished entering text into the edit box. The variable Contents is passed to the event with the entered text. If you return() a non-zero value, the OutputTarget will not be updated with the new text.
Multiline Edit Box Properties:
Main:
OutputTarget: the channel or variable that will receive whatever is entered into the edit box. Note that if you assign an invalid value to a channel or variable that is declared numeric, NaN will be assigned.
Format:
TextFormat, TextFormatPreset: the format (font etc.) of the text entered into the edit box.
TextBrush, TextBrushPreset: the brush (color) of the text entered into the edit box.
Common Properties:
These components include all the common properties of components plus the background properties described in section 7.4.4.
Variables:
The multiline edit box has the same variables as the Edit Box component.
Events:
The multiline edit box has the same events as the Edit Box component.
