Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
web:popupmenu [2019/06/06 20:42]
agcyphers [Enumerations]
web:popupmenu [2019/10/23 05:53] (current)
Line 26: Line 26:
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
 | DoubleClick() | Fires when the user double-clicks the field in MultiSelect. | | DoubleClick() | Fires when the user double-clicks the field in MultiSelect. |
 +| GotFocus() | Raised when the control receives focus. |
 +| LostFocus() | Raised when the control loses focus. |
 | SelectionAdded( theItem as GraffitiWebPopupMenuItem ) | Fires when an item is selected in MultiSelect. | | SelectionAdded( theItem as GraffitiWebPopupMenuItem ) | Fires when an item is selected in MultiSelect. |
 | SelectionChanged() | This event is fired when one or more items in the popupmenu are selected. | | SelectionChanged() | This event is fired when one or more items in the popupmenu are selected. |
Line 36: Line 38:
 | ClosePopup() | Closes the popup, if it is shown. | | ClosePopup() | Closes the popup, if it is shown. |
 | DeselectAll(DoLockUpdate as Boolean = False) | Clears the current selection. When DoLockUpdate is True, regardless of the value of the LockUpdate property, execution is deferred. | | DeselectAll(DoLockUpdate as Boolean = False) | Clears the current selection. When DoLockUpdate is True, regardless of the value of the LockUpdate property, execution is deferred. |
-| FindItem(ItemIndex as [[http://​developer.xojo.com/​integer|Integer]]) As GraffitiWebPopupMenuItem | Returns the item matching the parameters. | +| FindItem(ItemIndex as Integer) As GraffitiWebPopupMenuItem | Returns the item matching the parameters. | 
-| FindItem(strText as [[http://​developer.xojo.com/​string|String]]) As GraffitiWebPopupMenuItem | ::: |+| FindItem(strText as String) As GraffitiWebPopupMenuItem | ::: |
 | FindItemByTag (theTag as Variant) as GraffitiWebPopupMenuItem | Returns the item whose tag matches ''​theTag''​. | | FindItemByTag (theTag as Variant) as GraffitiWebPopupMenuItem | Returns the item whose tag matches ''​theTag''​. |
 | GetItemByID(theID as String) as GraffitiWebPopupMenuItem | Returns the item whose automatically generated ID matched ''​theID''​. | | GetItemByID(theID as String) as GraffitiWebPopupMenuItem | Returns the item whose automatically generated ID matched ''​theID''​. |
Line 43: Line 45:
 | GetItemIndexByTag(theTag as Variant) As Integer | Returns the index of the item whose tag matches ''​theTag''​. | | GetItemIndexByTag(theTag as Variant) As Integer | Returns the index of the item whose tag matches ''​theTag''​. |
 | GetSelectedItems() As GraffitiWebPopupMenuItem | Returns an array of items that are currently selected. | | GetSelectedItems() As GraffitiWebPopupMenuItem | Returns an array of items that are currently selected. |
-| GetSelectedItemsIndex() as [[http://​developer.xojo.com/​integer|Integer]]() | Returns an array of integers corresponding the indices of items selected in the popupmenu. | +| GetSelectedItemsIndex() as Integer() | Returns an array of integers corresponding the indices of items selected in the popupmenu. | 
-| ItemCount() as [[http://​developer.xojo.com/​integer|Integer]] | Returns the current count (UBound + 1) of items added to the PopupMenu. |+| ItemCount() as Integer | Returns the current count (UBound + 1) of items added to the PopupMenu. |
 | OpenPopup() | Opens the popup. | | OpenPopup() | Opens the popup. |
 | RemoveAllItems() | Removes all items from the popupmenu and updates the display. | | RemoveAllItems() | Removes all items from the popupmenu and updates the display. |
-| RemoveItem (ItemIndex as [[http://​developer.xojo.com/​integer|Integer]]) | Removes the specified item from the list of items in the popupmenu. | +| RemoveItem (ItemIndex as Integer) | Removes the specified item from the list of items in the popupmenu. | 
-| RemoveItem (ItemText as [[http://​developer.xojo.com/​string|String]]) | ::: | +| RemoveItem (ItemText as String) | ::: | 
-| SetItemSelect(ItemIndex as [[http://​developer.xojo.com/​integer|Integer]], ItemSelected as [[http://​developer.xojo.com/​boolean|Boolean]]) | Will set the item’s Selected property to ItemSelected. |+| SetItemSelect(ItemIndex as Integer, ItemSelected as Boolean) | Will set the item’s Selected property to ItemSelected. |
 | SetItemSelect(ItemText as String) | Will set the item’s Selected property to ItemSelected. | | SetItemSelect(ItemText as String) | Will set the item’s Selected property to ItemSelected. |
 | SetItemSelect(theItem as GraffitiWebPopupMenuItem) | Will set the item’s Selected property to ItemSelected. | | SetItemSelect(theItem as GraffitiWebPopupMenuItem) | Will set the item’s Selected property to ItemSelected. |
-| SetItemState(ItemIndex as [[http://​developer.xojo.com/​integer|Integer]], ItemState as [[http://​developer.xojo.com/​boolean|Boolean]]) | Will enable or disable the item at ItemIndex. |+| SetItemState(ItemIndex as Integer, ItemState as Boolean) | Will enable or disable the item at ItemIndex. |
 | SetText(theText as String) | Sets arbitrary text to the display for single select elements that do not have AllowAdd enabled. No effect otherwise. | | SetText(theText as String) | Sets arbitrary text to the display for single select elements that do not have AllowAdd enabled. No effect otherwise. |
  
 ==== Properties ==== ==== Properties ====
 ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^ ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
-| AllowAdd ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | When MultipleSelect = False, AllowAdd being tree will cause GraffitiWebPopupMenu to behave more like a combobox, allowing custom item input. |+| AllowAdd | Boolean | False | When MultipleSelect = False, AllowAdd being tree will cause GraffitiWebPopupMenu to behave more like a combobox, allowing custom item input. |
 | ContainerSkin | GraffitiWebPopupMenu.Skins | None | Sets the skin of the GraffitiWebPopupMenu. | | ContainerSkin | GraffitiWebPopupMenu.Skins | None | Sets the skin of the GraffitiWebPopupMenu. |
 | DropdownSkin | GraffitiWebPopupMenu.Skins | None | Sets the skin of the dropdown menu. | | DropdownSkin | GraffitiWebPopupMenu.Skins | None | Sets the skin of the dropdown menu. |
 | Items() | GraffitiWebPopupMenuItem | Nil | The array of items. ​ This array should not be changed directly, and only used as a reference. ​ | | Items() | GraffitiWebPopupMenuItem | Nil | The array of items. ​ This array should not be changed directly, and only used as a reference. ​ |
 | LockUpdate | Boolean | False | When True, code execution to manipulate and update the element in the browser is deferred until set to False. | | LockUpdate | Boolean | False | When True, code execution to manipulate and update the element in the browser is deferred until set to False. |
-| MaxSelecteditems ​| [[http://​developer.xojo.com/​integer|Integer]] | 5 | Limits the possible amount of selected items. | +| MaxSelecteditems | Integer | 5 | Limits the possible amount of selected items. | 
-| MinimumInputLength ​| [[http://​developer.xojo.com/​integer|Integer]] | 3 | Minimum number of characters user must enter before a search will be performed. ​ If 0, all items will be shown by default. | +| MinimumInputLength | Integer | 3 | Minimum number of characters user must enter before a search will be performed. ​ If 0, all items will be shown by default. | 
-| MultipleSelect ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Determines whether the popupmenu will support selection of multiple items. |+| MultipleSelect | Boolean | True | Determines whether the popupmenu will support selection of multiple items. |
 | PlaceholderSearchText | String | ""​ | Text to display in the search box for instances where MultipleSelect = False. | | PlaceholderSearchText | String | ""​ | Text to display in the search box for instances where MultipleSelect = False. |
-| PlaceholderText ​| [[http://​developer.xojo.com/​string|String]] | "​Please select an option"​ | The text to display when there are no items selected. | +| PlaceholderText | String | "​Please select an option"​ | The text to display when there are no items selected. | 
-| ReadOnly ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | If True, the user cannot change the value of the control. | +| ReadOnly | Boolean | False | If True, the user cannot change the value of the control. | 
-| SearchThreshold ​| [[http://​developer.xojo.com/​integer|Integer]] | 10 | The number of characters required to trigger the search algorithm. |+| SearchThreshold | Integer | 10 | The number of characters required to trigger the search algorithm. |
 | SearchType | GraffitiWebPopupMenu.SearchTypes | Contains | Method used when performing a search from the search box for GraffitiWebPopupMenuItems. | | SearchType | GraffitiWebPopupMenu.SearchTypes | Contains | Method used when performing a search from the search box for GraffitiWebPopupMenuItems. |
 | SelectedItem | GraffitiWebPopupMenuItem | Nil | When MultipleSelect = False, this property will contain the currently selected item. | | SelectedItem | GraffitiWebPopupMenuItem | Nil | When MultipleSelect = False, this property will contain the currently selected item. |