Index...
Centrallix Documentation
|
widget/textarea
textarea :: Visual multi-line text data entry widget.
Metadata:
| type: | widget/textarea |
| visual: | yes |
| container: | no |
| form element: | yes |
Overview:
The textarea is a multi-line text edit widget, allowing the user to enter text data containing line endings, tabs, and more. It also contains a scrollbar which allows more text to be edited than can fit in the displayable area.
Usage:
The textarea is a visual form element widget, and can be contained inside any container capable of holding visual widgets. It may only contain nonvisual widgets like the connector.
Properties:
| Property | Type | Description |
|---|
| background |
string |
A background image for the textarea. |
| bgcolor |
string |
A color, RGB or named, to be used as the background. If neither bgcolor nor background are specified, the textarea is transparent. |
| fieldname |
string |
The field in the objectsource to associate this textarea with. |
| height |
integer |
The height of the textarea, in pixels |
| maxchars |
integer |
The maximum number of characters the textarea should accept from the user |
| readonly |
yes/no |
Set to 'yes' if the data in the text area should be viewed only and not be modified |
| style |
string |
The border style of the text area, can be 'raised' or 'lowered'. Default is 'raised'. |
| width |
integer |
The width of the textarea, in pixels |
| x |
integer |
The horizontal coordinate of the left edge of the textarea, relative to the container. |
| y |
integer |
The vertical coordinate of the top edge of the textarea, relative to the container. |
Child Properties:
none currently available
Actions:
none currently available
Events:
| Event | Description |
|---|
| Click |
This event occurs when the user clicks the widget. No parameters are available from this event. |
| MouseUp |
This event occurs when the user releases the mouse button on the widget. |
| MouseDown |
This event occurs when the user presses the mouse button on the widget. This differs from the 'Click' event in that the user must actually press and release the mouse button on the widget for a Click event to fire, whereas simply pressing the mouse button down will cause the MouseDown event to fire. |
| MouseOver |
This event occurs when the user first moves the mouse pointer over the widget. It will not occur again until the user moves the mouse off of the widget and then back over it again. |
| MouseOut |
This event occurs when the user moves the mouse pointer off of the widget. |
| MouseMove |
This event occurs when the user moves the mouse pointer while it is over the widget. The event will repeatedly fire each time the pointer moves. |
| DataChange |
This event occurs when the data value of the widget has changed. |
| Modified |
This event occurs when the user modifies the data value of the widget (the distinction from 'DataChange' is that in this case the user modified the data value, whereas DataChange can occur even when the form containing the textarea views a new object, but also by user modification). |
| LoseFocus |
This event occurs when the textarea loses keyboard focus (if the user tabs off of it, for instance). |
| GetFocus |
This event occurs when the textarea receives keyboard focus (if the user tabs on to it or clicks on it, for instance). |
Client Properties:
none currently available
Sample Code:
none currently available
Comments...
(none yet)
Add a Comment...
|
