Difference between revisions of "Textbox"
From Lianjapedia
Yvonne.milne (Talk | contribs) m (Yvonne.milne moved page Visage Application Framework - Textbox to Textbox without leaving a redirect) |
Barrymavin (Talk | contribs) (→Events) |
||
(17 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
+ | Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages. | ||
+ | |||
+ | ====Description==== | ||
+ | Shown below in a standalone [[Form]]. Click the image to see in a [[Custom_Sections_and_Gadgets|Custom Section]] in a Lianja [[Page Attributes|Page]]. | ||
+ | |||
+ | [[{{ns:file}}:textbox.png|link={{filepath:textbox_cs.png}}|Textbox]] | ||
+ | |||
+ | Textbox is the default data entry and editing control. | ||
+ | |||
====Properties==== | ====Properties==== | ||
− | This class supports the | + | This class supports the [[:Category:Common_Properties|Common Properties]] plus the following: |
− | {| class="wikitable" | + | {| class="wikitable" width="100%" |
!width="20%"|Property | !width="20%"|Property | ||
!Access (R/RW) | !Access (R/RW) | ||
Line 9: | Line 18: | ||
!width="50%"|Description | !width="50%"|Description | ||
|- | |- | ||
− | | | + | |valign="top"|Alignment |
− | |RW | + | |valign="top"|RW |
− | | | + | |valign="top"|Numeric |
− | | | + | |valign="top"|Alignment: 0 = left, 1 = right, 2 = center |
|- | |- | ||
− | | | + | |valign="top"|Autosuggest |
− | |RW | + | |valign="top"|RW |
− | | | + | |valign="top"|Character |
− | | | + | |valign="top"|List of values to be suggested as the user types (comma-separated or SQL select statement) |
|- | |- | ||
− | | | + | |valign="top"|Autosuggestcolumn |
− | |RW | + | |valign="top"|RW |
− | | | + | |valign="top"|Numeric |
− | | | + | |valign="top"|The column to search for Autosuggestions |
|- | |- | ||
− | | | + | |valign="top"|ContextMenu |
− | |RW | + | |valign="top"|RW |
− | | | + | |valign="top"|Character |
− | | | + | |valign="top"|Comma-separated list of menuitems for a right click context menu |
|- | |- | ||
− | | | + | |valign="top"|DataMappingGet |
− | |RW | + | |valign="top"|RW |
− | | | + | |valign="top"|Character |
− | | | + | |valign="top"|Get Data Mapping |
|- | |- | ||
− | | | + | |valign="top"|DataMappingSet |
+ | |valign="top"|RW | ||
+ | |valign="top"|Character | ||
+ | |valign="top"|Set Data Mapping | ||
+ | |- | ||
+ | |InputMask | ||
|RW | |RW | ||
− | | | + | |Character |
− | | | + | |Input mask to format text |
+ | |- | ||
+ | |valign="top"|PasswordChar | ||
+ | |valign="top"|RW | ||
+ | |valign="top"|Character | ||
+ | |valign="top"|Character displayed to hide sensitive data such as passwords | ||
+ | |- | ||
+ | |valign="top"|Placeholder | ||
+ | |valign="top"|RW | ||
+ | |valign="top"|Character | ||
+ | |valign="top"|Text to display grayed-out when field is empty and does not have focus | ||
|- | |- | ||
|Readonly | |Readonly | ||
|RW | |RW | ||
− | | | + | |Boolean |
− | | | + | |Whether object is read only |
|- | |- | ||
− | | | + | |valign="top"|Returntabs |
− | |RW | + | |valign="top"|RW |
− | | | + | |valign="top"|Boolean |
− | | | + | |valign="top"|Whether the return key should be treated as a tab |
|- | |- | ||
− | | | + | |valign="top"|SelectOnEntry |
+ | |valign="top"|RW | ||
+ | |valign="top"|Boolean | ||
+ | |valign="top"|Whether value is selected when object is entered | ||
+ | |- | ||
+ | |Text | ||
|RW | |RW | ||
− | | | + | |Character |
− | | | + | |Object's text value |
+ | |- | ||
+ | |valign="top"|Tooltip | ||
+ | |valign="top"|RW | ||
+ | |valign="top"|Character | ||
+ | |valign="top"|Text displayed when mouse hovers over object. This may contain {expr} dynamic content macros. | ||
+ | |- | ||
+ | |valign="top"|Validation | ||
+ | |valign="top"|RW | ||
+ | |valign="top"|Character | ||
+ | |valign="top"|String containing boolean expression to validate data entry | ||
+ | |- | ||
+ | |valign="top"|ValidationErrorMessage | ||
+ | |valign="top"|RW | ||
+ | |valign="top"|Character | ||
+ | |valign="top"|Message displayed if validation returns False | ||
+ | |- | ||
+ | |valign="top"|Value | ||
+ | |valign="top"|RW | ||
+ | |valign="top"|Expr | ||
+ | |valign="top"|Object's value, which can be any valid data type | ||
|- | |- | ||
|} | |} | ||
Line 58: | Line 107: | ||
====Methods==== | ====Methods==== | ||
− | This class supports the | + | This class supports the [[:Category:Common_Methods|Common Methods]] plus the following: |
− | {| class="wikitable" | + | {| class="wikitable" width="100%" |
!width="20%"|Method | !width="20%"|Method | ||
!Args | !Args | ||
!width="50%"|Description | !width="50%"|Description | ||
− | + | |- | |
+ | |selectAll||None||Selects all text in the control | ||
|} | |} | ||
====Events==== | ====Events==== | ||
− | This class supports the | + | This class supports the [[:Category:Common_Events|Common Events]] plus the following: |
− | {| class="wikitable" | + | {| class="wikitable" width="100%" |
!width="20%"|Event | !width="20%"|Event | ||
!Args | !Args | ||
!width="50%"|Description | !width="50%"|Description | ||
− | + | |- | |
+ | |InteractiveChange||None||Occurs when each key is pressed | ||
+ | |- | ||
+ | |Change||None||Occurs when Tab or return key is pressed | ||
+ | |- | ||
+ | |HotKeyPress||The key pressed as a string e.g. Ctrl+F1, F2 etc||Occurs when a hotkey is pressed and released in the object | ||
|} | |} | ||
Latest revision as of 05:25, 29 September 2020
Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.
Contents
Description
Shown below in a standalone Form. Click the image to see in a Custom Section in a Lianja Page.
Textbox is the default data entry and editing control.
Properties
This class supports the Common Properties plus the following:
Property | Access (R/RW) | Value | Description |
---|---|---|---|
Alignment | RW | Numeric | Alignment: 0 = left, 1 = right, 2 = center |
Autosuggest | RW | Character | List of values to be suggested as the user types (comma-separated or SQL select statement) |
Autosuggestcolumn | RW | Numeric | The column to search for Autosuggestions |
ContextMenu | RW | Character | Comma-separated list of menuitems for a right click context menu |
DataMappingGet | RW | Character | Get Data Mapping |
DataMappingSet | RW | Character | Set Data Mapping |
InputMask | RW | Character | Input mask to format text |
PasswordChar | RW | Character | Character displayed to hide sensitive data such as passwords |
Placeholder | RW | Character | Text to display grayed-out when field is empty and does not have focus |
Readonly | RW | Boolean | Whether object is read only |
Returntabs | RW | Boolean | Whether the return key should be treated as a tab |
SelectOnEntry | RW | Boolean | Whether value is selected when object is entered |
Text | RW | Character | Object's text value |
Tooltip | RW | Character | Text displayed when mouse hovers over object. This may contain {expr} dynamic content macros. |
Validation | RW | Character | String containing boolean expression to validate data entry |
ValidationErrorMessage | RW | Character | Message displayed if validation returns False |
Value | RW | Expr | Object's value, which can be any valid data type |
Methods
This class supports the Common Methods plus the following:
Method | Args | Description |
---|---|---|
selectAll | None | Selects all text in the control |
Events
This class supports the Common Events plus the following:
Event | Args | Description |
---|---|---|
InteractiveChange | None | Occurs when each key is pressed |
Change | None | Occurs when Tab or return key is pressed |
HotKeyPress | The key pressed as a string e.g. Ctrl+F1, F2 etc | Occurs when a hotkey is pressed and released in the object |