Difference between revisions of "Listbox"
From Lianjapedia
Barrymavin (Talk | contribs) (Created page with '====Properties==== This class supports the '''Common properties''' plus the following: {| class="wikitable" !width="20%"|Property !Access (R/RW) !Value !width="50%"|Description…') |
Yvonne.milne (Talk | contribs) (→Properties) |
||
(17 intermediate revisions by 2 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}}:listbox.png|link={{filepath:listbox_cs.png}}|Listbox]] | ||
+ | |||
+ | Listbox is a control with a single column list. | ||
+ | |||
====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"|ActiveRow | |
+ | |valign="top"|RW | ||
+ | |valign="top"|Numeric | ||
+ | |valign="top"|Currently selected row number | ||
+ | |- | ||
+ | |valign="top"|ColumnCount | ||
+ | |valign="top"|RW | ||
+ | |valign="top"|Numeric | ||
+ | |valign="top"| Number of columns in the List | ||
+ | |- | ||
+ | |valign="top"|KineticScrolling | ||
+ | |valign="top"|RW | ||
+ | |valign="top"|Boolean | ||
+ | |valign="top"|Whether kinetic scrolling is enabled, default is False. With kinetic scrolling, the user can flick in a given direction and it will continue to scroll in this direction until it is stopped either by the user or by friction. Setting KineticScrolling to true provides touch scrolling on touch aware devices and left mouse button pressed and moved scrolling on non-touch aware devices. | ||
+ | |- | ||
+ | |valign="top"|ListCount | ||
+ | |valign="top"|R | ||
+ | |valign="top"|Numeric | ||
+ | |valign="top"|Number of items in the List | ||
+ | |- | ||
+ | |valign=top|ListIndex | ||
+ | |valign=top|RW | ||
+ | |valign=top|Numeric | ||
+ | |Current item index value. Starts from 1. | ||
+ | |- | ||
+ | |valign="top"|RowCount | ||
+ | |valign="top"|R | ||
+ | |valign="top"|Numeric | ||
+ | |valign="top"|Number of rows in the List | ||
+ | |- | ||
+ | |valign="top"|RowSource | ||
+ | |valign="top"|RW | ||
+ | |valign="top"|Character | ||
+ | |valign="top"|Source of data to which the object is bound | ||
+ | |- | ||
+ | |valign="top"|RowSourceType | ||
+ | |valign="top"|RW | ||
+ | |valign="top"|Numeric | ||
+ | |valign="top"|Type of Source of data to which the object is bound: 1 = comma-separated string, 2 = table, 3 = SQL statement, 5 = array, 6 = comma-separated fieldlist, 8 = table field structure | ||
+ | |- | ||
+ | |valign="top"|Text | ||
+ | |valign="top"|RW | ||
+ | |valign="top"|Character | ||
+ | |valign="top"|Currently selected row text | ||
+ | |- | ||
+ | |valign="top"|Value | ||
+ | |valign="top"|RW | ||
+ | |valign="top"|Character | ||
+ | |valign="top"|Currently selected row text | ||
+ | |- | ||
|} | |} | ||
====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 | ||
− | + | |- | |
+ | |AddItem | ||
+ | |item as Character | ||
+ | |Add an item | ||
+ | |- | ||
+ | |valign="top"|AddItems | ||
+ | |valign="top"|selectstatement as Character | commalist as Character | pipelist as Character | items as Array | ||
+ | |valign="top"|Add items based on an SQL SELECT query, a comma-separated list, a pipe-separated list or an array | ||
+ | |- | ||
+ | |Clear | ||
+ | |None | ||
+ | |Clear the ListBox | ||
+ | |- | ||
+ | |Item | ||
+ | |itemnumber as Numeric | ||
+ | |Return the text of the specified item | ||
+ | |- | ||
+ | |List | ||
+ | |itemnumber as Numeric | ||
+ | |Return the text of the specified item | ||
+ | |- | ||
+ | |valign="top"|RemoveItem | ||
+ | |valign="top"|itemtext as Character | itemnumber as Numeric | ||
+ | |valign="top"|Remove the specified item | ||
+ | |- | ||
|} | |} | ||
====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 | ||
Line 33: | Line 115: | ||
|} | |} | ||
+ | |||
+ | [[Category:Documentation]] | ||
+ | [[Category:Framework Classes]] |
Revision as of 05:25, 13 April 2018
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.
Listbox is a control with a single column list.
Properties
This class supports the Common Properties plus the following:
Property | Access (R/RW) | Value | Description |
---|---|---|---|
ActiveRow | RW | Numeric | Currently selected row number |
ColumnCount | RW | Numeric | Number of columns in the List |
KineticScrolling | RW | Boolean | Whether kinetic scrolling is enabled, default is False. With kinetic scrolling, the user can flick in a given direction and it will continue to scroll in this direction until it is stopped either by the user or by friction. Setting KineticScrolling to true provides touch scrolling on touch aware devices and left mouse button pressed and moved scrolling on non-touch aware devices. |
ListCount | R | Numeric | Number of items in the List |
ListIndex | RW | Numeric | Current item index value. Starts from 1. |
RowCount | R | Numeric | Number of rows in the List |
RowSource | RW | Character | Source of data to which the object is bound |
RowSourceType | RW | Numeric | Type of Source of data to which the object is bound: 1 = comma-separated string, 2 = table, 3 = SQL statement, 5 = array, 6 = comma-separated fieldlist, 8 = table field structure |
Text | RW | Character | Currently selected row text |
Value | RW | Character | Currently selected row text |
Methods
This class supports the Common Methods plus the following:
Method | Args | Description |
---|---|---|
AddItem | item as Character | Add an item |
AddItems | selectstatement as Character | commalist as Character | pipelist as Character | items as Array | Add items based on an SQL SELECT query, a comma-separated list, a pipe-separated list or an array |
Clear | None | Clear the ListBox |
Item | itemnumber as Numeric | Return the text of the specified item |
List | itemnumber as Numeric | Return the text of the specified item |
RemoveItem | itemtext as Character | itemnumber as Numeric | Remove the specified item |
Events
This class supports the Common Events plus the following:
Event | Args | Description |
---|