See Also

Enumerations

Name Values
SearchTypes Contains
BeginsWith
Skins None
Error
Success
Warning
Grey
DarkGrey
LightBlue
Blue
Lime
Pomelo
Orange
BlueGreen

Constants

Name Type Value
This class exposes no constants.

Events

Definition Description
DoubleClick() Fires when the user double-clicks the field 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.
SelectionRemoved( theItem as GraffitiWebPopupMenuItem ) Fires when an items is deselected in MultiSelect.

Methods

Definition Description
AddItem(ItemText as String) Adds a new item to the list of items in the popupmenu.
AddItem(NewItem as GraffitiWebPopupMenuItem) Adds a new item to list of items in the popupmenu.
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.
FindItem(ItemIndex as Integer) As GraffitiWebPopupMenuItem Returns the item matching the parameters.
FindItem(strText as String) As GraffitiWebPopupMenuItem
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.
GetItemIndex(theItem as GraffitiWebPopupMenuItem) as Integer Returns the index of the specified item.
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.
GetSelectedItemsIndex() as Integer() Returns an array of integers corresponding the indices of items selected in the popupmenu.
ItemCount() as Integer Returns the current count (UBound + 1) of items added to the PopupMenu.
OpenPopup() Opens the popup.
RemoveAllItems() Removes all items from the popupmenu and updates the display.
RemoveItem (ItemIndex as Integer) Removes the specified item from the list of items in the popupmenu.
RemoveItem (ItemText as String)
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(theItem as GraffitiWebPopupMenuItem) Will set the item’s Selected property to ItemSelected.
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.

Properties

Name Type Default Value Description
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.
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.
LockUpdate Boolean False When True, code execution to manipulate and update the element in the browser is deferred until set to False.
MaxSelecteditems Integer 5 Limits the possible amount of selected items.
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 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.
PlaceholderText String “Please select an option” The text to display when there are no items selected.
ReadOnly Boolean False If True, the user cannot change the value of the control.
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.
SelectedItem GraffitiWebPopupMenuItem Nil When MultipleSelect = False, this property will contain the currently selected item.
StyleTag WebStyle Nil Style applied to tags when MultipleSelect = True.

Examples

There are currently no examples for this class.

  • Last modified: 6 weeks ago
  • by agcyphers