Difference between revisions of "Combobox"

From Lianjapedia
Jump to: navigation, search
(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…')
 
(→‎Events)
 
(30 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}}:combobox.png|link={{filepath:combobox_cs.png}}|Combobox]]
 +
 +
When selected, the ComboBox control opens, displaying a list of items from which you can choose one. A ComboBox control combines the features of a TextBox control and a ListBox control. You can enter information in the text box portion or select an item from the list box portion of the control.
 +
 
====Properties====
 
====Properties====
  
−
This class supports the '''Common properties''' plus the following:
+
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
 
|-
 
|-
−
 
+
|ColumnCount
 +
|RW
 +
|Numeric
 +
|Number of columns
 +
|-
 +
|ExtendItems
 +
|RW
 +
|Boolean
 +
|If True, extend items
 +
|-
 +
|ListCount
 +
|R
 +
|Numeric
 +
|Number of items in the list
 +
|-
 +
|valign=top|ListIndex
 +
|valign=top|RW
 +
|valign=top|Numeric
 +
|Current item index value.  Starts from 1.
 +
|-
 +
|Readonly
 +
|RW
 +
|Boolean
 +
|If True, object cannot be modified
 +
|-
 +
|RowSource
 +
|RW
 +
|Character
 +
|Row data source
 +
|-
 +
|RowSourceType
 +
|RW
 +
|Numeric
 +
|Row data source type
 +
|-
 +
|valign=top|Text
 +
|valign=top|RW
 +
|valign=top|Character
 +
|Current item text value.
 +
|-
 +
|Validation
 +
|RW
 +
|Character
 +
|String containing boolean expression to validate data entry
 +
|-
 +
|ValidationErrorMessage
 +
|RW
 +
|Character
 +
|Message displayed if validation returns False
 +
|-
 +
|Value
 +
|RW
 +
|Character or numeric
 +
|Current item text or index value
 +
|-
 
|}
 
|}
  
 
====Methods====
 
====Methods====
  
−
This class supports the '''Common methods''' plus the following:
+
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 the specified item
 +
|-
 +
|valign=top|AddItems
 +
|selectstatement as Character | commalist as Character | pipelist as Character | items as Array[, icon as Character]
 +
|valign=top|Add the specified items: comma-separated list, pipe-separated list or elements of the specified array, optional including the filename of an icon.
 +
|-
 +
|Clear
 +
|None
 +
|Remove all items
 +
|-
 +
|List
 +
|index as numeric
 +
|Return the specified item text
 +
|-
 +
|RemoveItem
 +
|item as Character | index as Numeric
 +
|Remove the specified object
 +
|-
 
|}
 
|}
  
 
====Events====
 
====Events====
  
−
This class supports the '''Common events''' plus the following:
+
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 a selection is made
 +
|-
  
−
|}
+
 
 +
 
 +
[[Category:Documentation]]
 +
[[Category:Framework Classes]]

Latest revision as of 23:41, 9 May 2024

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 Section in a Lianja Page.

Combobox

When selected, the ComboBox control opens, displaying a list of items from which you can choose one. A ComboBox control combines the features of a TextBox control and a ListBox control. You can enter information in the text box portion or select an item from the list box portion of the control.

Properties

This class supports the Common Properties plus the following:

Property Access (R/RW) Value Description
ColumnCount RW Numeric Number of columns
ExtendItems RW Boolean If True, extend items
ListCount R Numeric Number of items in the list
ListIndex RW Numeric Current item index value. Starts from 1.
Readonly RW Boolean If True, object cannot be modified
RowSource RW Character Row data source
RowSourceType RW Numeric Row data source type
Text RW Character Current item text value.
Validation RW Character String containing boolean expression to validate data entry
ValidationErrorMessage RW Character Message displayed if validation returns False
Value RW Character or numeric Current item text or index value

Methods

This class supports the Common Methods plus the following:

Method Args Description
AddItem item as Character Add the specified item
AddItems selectstatement as Character | commalist as Character | pipelist as Character | items as Array[, icon as Character] Add the specified items: comma-separated list, pipe-separated list or elements of the specified array, optional including the filename of an icon.
Clear None Remove all items
List index as numeric Return the specified item text
RemoveItem item as Character | index as Numeric Remove the specified object

Events

This class supports the Common Events plus the following:

Event Args Description
InteractiveChange None Occurs when a selection is made
Retrieved from "https://www.lianja.com/doc/index.php?title=Combobox&oldid=27139"