DropDown (PRIM_LIST.DropDown)

DropDown List Data in table format

Ancestors - List (PRIM_LIST)Control (PRIM_CTRL)Object (PRIM_OBJT)

Details

A DropDown is a list based control that when clicked expands to show the list of available values.
 
Depending on configuration, a DropDown can also allow data entry in the edit portion of the control.
 
When an item is chosen from the DropDown, the field values associated with underlying list entry will be returned to the parent component.
 
Prim_list.Dropdown is a variation of PRIM_LIST. The result is that the drop down list itself supports nearly all of the functionality available to standard list. Dropdowns therefore can have a tree in the drop down portion or use reusable parts for individual cells so that the list can be formatted in a countless number of ways.

Properties

Name Description
AlternateItemThemeDrawStyle ThemeDrawStyle to be applied to alternate items Inherited from List (PRIM_LIST)
AutoSelect Automatically select the text when the control receives focus
AutoSelectItem Automatically select the first item when the list is loaded Inherited from List (PRIM_LIST)
BusyUpdates BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL)
BusyUpdatesOfParent BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL)
CanFocus CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL)
CheckBoxes Show a checkbox for each item in the list Inherited from List (PRIM_LIST)
ColumnDrag Specifies whether columns can be reordered by the user Inherited from List (PRIM_LIST)
ColumnHeaderHeight Height of the column header area in pixels Inherited from List (PRIM_LIST)
ColumnHeaderSizing Determines how column headers will resize Inherited from List (PRIM_LIST)
ColumnLines Show the column separator lines Inherited from List (PRIM_LIST)
ColumnMarginLeft Left Margin of column in pixels Inherited from List (PRIM_LIST)
ColumnMarginRight Right Margin of column in pixels Inherited from List (PRIM_LIST)
ColumnMouseOverStyle Style applied to the column heading when mouse over Inherited from List (PRIM_LIST)
ColumnMouseOverStyles Collection of styles applied to the column heading when mouse over Inherited from List (PRIM_LIST)
ColumnPressedStyle Style applied to the column heading on mouse down Inherited from List (PRIM_LIST)
ColumnPressedStyles Collection of styles applied to the column heading on mouse down Inherited from List (PRIM_LIST)
Columns Collection of columns defined for the list Inherited from List (PRIM_LIST)
ColumnSortArrow Show the column sort arrow if the primary sort Inherited from List (PRIM_LIST)
ColumnStyle Style applied to the column heading on mouse down Inherited from List (PRIM_LIST)
ColumnStyles Collection of styles applied to the column heading Inherited from List (PRIM_LIST)
ColumnThemeDrawStyle Name of the Theme DrawStyle to be applied to the column headings Inherited from List (PRIM_LIST)
ComponentClassName ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembers ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternName ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTag Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentType ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeName ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
CurrentItem Base class for all Prim_List Current Item classes Inherited from List (PRIM_LIST)
CurrentPage Specifies the current page to be displayed Inherited from List (PRIM_LIST)
Cursor Cursor sets the cursor image Inherited from Control (PRIM_CTRL)
DataClass Reference to a repository field or fundamental product data class used to control data entry
DisplayAlignment DisplayAlignment sets edit box alignment when not in focus
DisplayPosition DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL)
DragStyle DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL)
DropDownCount Number of items to be shown when the list expands
DropDownOpen Returns true if the dropdown is currently expanded
DropDownStyle Dropdown or DropdownList. Dropdown supports editing in the value area, while DropdownList simply shows the list
DropDownWidth Width of the dropdown area as a percentage of the dropdown
EditAlignment EditAlignment sets the alignment of the text when in focus
Enabled Enable activates/deactivates the component Inherited from Control (PRIM_CTRL)
EnterKeyStyle EnterKeyStyle determines what happens when Enter key is pressed in a list Inherited from List (PRIM_LIST)
Filter String to be searched for to filter the list Inherited from List (PRIM_LIST)
FixedPosition Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL)
Focus Focus tells whether the component has focus Inherited from Control (PRIM_CTRL)
FocusColumn Reference to the active column in the list Inherited from List (PRIM_LIST)
FocusedStyle Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusedStyles Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusItem Reference to the focus item in the list Inherited from List (PRIM_LIST)
Handle Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL)
HasSelection True if some of the editable text is selected
Height The height of the control in pixels Inherited from Control (PRIM_CTRL)
Hint Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL)
HintPopup HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL)
HintShow Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL)
HintShowOfParent Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL)
HintTitle HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL)
HorizontalScrollInc HorizontalScrollInc specifies the pixel increment for horizontal scroll bar. Inherited from List (PRIM_LIST)
HorizontalScrollPos HorizontalScrollPos sets the position of the horizontal scroll bar Inherited from List (PRIM_LIST)
IsAnimating IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL)
IsRealized True if the control is currently realized Inherited from Control (PRIM_CTRL)
Items Collection of items in the list Inherited from List (PRIM_LIST)
ItemThemeDrawStyle Name of the Theme DrawStyle to be applied to the items Inherited from List (PRIM_LIST)
KeyboardPositioning Determines how the list will position based on keyboard input Inherited from List (PRIM_LIST)
Left Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL)
Modified Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL)
ModifiedRules Controls when the Modified property is set to True Inherited from List (PRIM_LIST)
MouseOver MouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL)
MouseOverStyle MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
MouseOverStyles MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
Name Name identifies the component Inherited from Object (PRIM_OBJT)
NotificationStyle NotificationStyle controls how events are triggered Inherited from List (PRIM_LIST)
Opacity Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL)
Owner Owner owns this component Inherited from Object (PRIM_OBJT)
Parent Reference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL)
Popup Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL)
PopupMenu Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL)
ReadOnly ReadOnly controls whether a component can be used for input
Rotation Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL)
RotationOriginLeft RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RotationOriginTop RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RowHeight Height of a row in pixels Inherited from List (PRIM_LIST)
RowLines Show the row separator lines Inherited from List (PRIM_LIST)
RowResize Allow rows to be resized Inherited from List (PRIM_LIST)
RowSizing Determines how rows will resize Inherited from List (PRIM_LIST)
RowsPerPage Specifies how many rows will appear per page Inherited from List (PRIM_LIST)
ScaleHeight ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScaleOriginLeft ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleOriginTop ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleWidth ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScreenLeft ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL)
ScreenTop ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL)
ScrollLeft Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
ScrollTop Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
SelectedRowCount SelectedRowCount shows how many columns have been selected Inherited from List (PRIM_LIST)
SelectionEnd Position in the value that selection ends
SelectionStart Position in the value that selection starts
SelectionStyle Specifies the rules for item selection within the list Inherited from List (PRIM_LIST)
ShowPages Show or hide the paging buttons Inherited from List (PRIM_LIST)
ShowSelection Show selection when the control does not have focus
SkewLeft SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL)
SkewOriginLeft SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewOriginTop SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewTop SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL)
Style Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL)
Styles Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL)
TabPosition TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL)
TabStop Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL)
Text Text contains the formatted data currently showing in the edit area
ThemeDrawStyle Name of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL)
Top Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL)
TouchMove Determines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL)
TouchRotate Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL)
TouchScale Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL)
TouchSize Determines whether a control can be resized Inherited from Control (PRIM_CTRL)
TreeButtons Show or hide the expand/collapse images Inherited from List (PRIM_LIST)
Value Value of the data class
VerticalScrollInc VerticalScrollInc specifies the pixel increment for vertical scroll bar. Inherited from List (PRIM_LIST)
VerticalScrollPos VerticalScrollPos sets the position of the vertical scroll bar Inherited from List (PRIM_LIST)
Virtualization Specifies if a list is a virtualized. Inherited from List (PRIM_LIST)
Visible Show or hide the control Inherited from Control (PRIM_CTRL)
VisualStyle VisualStyle sets the appearance Inherited from Control (PRIM_CTRL)
VisualStyleOfParent Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL)
Width Width of the component in pixels Inherited from Control (PRIM_CTRL)

Events

Name Description
AnimationEnded Fired when an animation is ended Inherited from Control (PRIM_CTRL)
Cancelled
AutoCompleting Fired as the user enters a value in the edit, allowing for the value to be replaced with a new value
Value, Handled
Changed Changed is a change in the component Inherited from Control (PRIM_CTRL)
CloseUp Fired when the dropdown is closed
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from Control (PRIM_CTRL)
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Control (PRIM_CTRL)
DragDrop Fired on mouse up to signify the end of a drag process Inherited from Control (PRIM_CTRL)
PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult
DragOver Fired during the drag and drop process when the cursor moves over the control Inherited from Control (PRIM_CTRL)
PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled
DropDown Fired when the dropdown is opened
Continue
DropDownEditChanged Fired when the edit portion of the drop down is changed by the user
DropDownValueChanged Fired when the value of the dropdown edit is modified
Item, Value, Image
EndDrag Fired when the drag and drop process has completed Inherited from Control (PRIM_CTRL)
Source, Payload, DragResult, AggregatedSource, Origin, Handled
Enter Fired when the Enter key is pressed Inherited from Control (PRIM_CTRL)
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
GotFocus Fired when the control receives the focus Inherited from Control (PRIM_CTRL)
Initialize Fired after a component has been realized for the first time Inherited from Control (PRIM_CTRL)
ItemChanged ItemChanged happens when an item is changed Inherited from Control (PRIM_CTRL)
Item
ItemClick Fired when an item is clicked Inherited from Control (PRIM_CTRL)
Item
ItemCollapsed An item in the list has collapsed Inherited from Control (PRIM_CTRL)
Item
ItemDoubleClick Fired when the user double clicks an item in the list Inherited from Control (PRIM_CTRL)
Item
ItemExpanding An item in the list is expanding Inherited from Control (PRIM_CTRL)
Item
ItemGotFocus Fired when an item receives the focus Inherited from Control (PRIM_CTRL)
Item
ItemGotSelection Fired when an item in the list becomes selected Inherited from Control (PRIM_CTRL)
Item
ItemLostFocus Fired when the item loses focus Inherited from Control (PRIM_CTRL)
Item
ItemLostSelection ItemLostSelection happens when another item is selected Inherited from Control (PRIM_CTRL)
Item
ItemMouseEnter The mouse has entered the bounds of the item Inherited from Control (PRIM_CTRL)
Item
ItemMouseHover The mouse is hovering over the item Inherited from Control (PRIM_CTRL)
Item
ItemMouseLeave The mouse has left the bounds of the item Inherited from Control (PRIM_CTRL)
Item
ItemRealizing Fired when an item design instance is realized, typically when the it comes in to the view port Inherited from Control (PRIM_CTRL)
Item
KeyPress Fired when a key is pressed on the keyboard Inherited from Control (PRIM_CTRL)
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
LostFocus LostFocus happens when a component is no longer active Inherited from Control (PRIM_CTRL)
MouseEnter The mouse has entered the bounds of the control Inherited from Control (PRIM_CTRL)
MouseHover The mouse has hovered over the control Inherited from Control (PRIM_CTRL)
Origin, Handled
MouseLeave The mouse has left the bounds of the control Inherited from Control (PRIM_CTRL)
ScrollChanged Fired when the scrollbars in a composite control are moved Inherited from Control (PRIM_CTRL)
Orientation
StartDrag Fired when the user starts a drag and drop process Inherited from Control (PRIM_CTRL)
Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled
TouchChange Fired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events Inherited from Control (PRIM_CTRL)
MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue
TouchEnd Fired when the user stops touching the screen Inherited from Control (PRIM_CTRL)
TouchStart Fired when the user first makes physical contact with the screen Inherited from Control (PRIM_CTRL)
Origin, TouchMove, TouchRotate, TouchScale, TouchSize

Methods

Name Description
CloseDropDown Forces the listbox portion of the DropDown to be closed
Export Exports list data to text file Inherited from List (PRIM_LIST)
FileName, Type
FadeIn Animate from invisible to visible Inherited from Control (PRIM_CTRL)
Duration, Delay
FadeOut Animate from visible to invisible Inherited from Control (PRIM_CTRL)
Duration, Delay, Visible
FindItem Executes the OnFind method on the design interface for all list items Inherited from List (PRIM_LIST)
Result, Key, StartItem
FindReference Find an object stored as a RelatedReference Inherited from List (PRIM_LIST)
Result, RelatedReference, StartItem
MoveFrom Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
MoveTo Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
OpenDropDown Forces the listbox portion of a DropDown to be shown
Realize Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
Scale Animate a change of scale Inherited from Control (PRIM_CTRL)
ScaleWidth, ScaleHeight, Duration, Delay
SetFocus Sets the control to be the focus control Inherited from Control (PRIM_CTRL)
ShowMessages LANSA Internal Use Inherited from Control (PRIM_CTRL)
SizeTo Changes and animates control size changing Inherited from Control (PRIM_CTRL)
Width, Height, Duration, Delay
Unrealize Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
UpdateDisplay UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL)
VerticalScrollTo Set the vertical scroll position using an item Inherited from List (PRIM_LIST)
Item, ScrollPosition

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020