DropDown (PRIM_LIST.DropDown)

DropDown List Data in table format

Ancestors - List (PRIM_LIST) Container (PRIM_CPST) 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

NameDescription
AlternateItemThemeDrawStyleThemeDrawStyle to be applied to alternate items Inherited from List (PRIM_LIST)
AutoSelectAutomatically select the text when the control receives focus
AutoSelectItemAutomatically select the first item when the list is loaded Inherited from List (PRIM_LIST)
BusyUpdatesBusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL)
BusyUpdatesOfParentBusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL)
CanFocusCanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL)
CheckBoxesShow a checkbox for each item in the list Inherited from List (PRIM_LIST)
ColumnDragSpecifies whether columns can be reordered by the user Inherited from List (PRIM_LIST)
ColumnHeaderHeightHeight of the column header area in pixels Inherited from List (PRIM_LIST)
ColumnHeaderSizingDetermines how column headers will resize Inherited from List (PRIM_LIST)
ColumnLinesShow the column separator lines Inherited from List (PRIM_LIST)
ColumnMouseOverStyleStyle applied to the column heading when mouse over Inherited from List (PRIM_LIST)
ColumnMouseOverStylesCollection of styles applied to the column heading when mouse over Inherited from List (PRIM_LIST)
ColumnPressedStyleStyle applied to the column heading on mouse down Inherited from List (PRIM_LIST)
ColumnPressedStylesCollection of styles applied to the column heading on mouse down Inherited from List (PRIM_LIST)
ColumnsCollection of columns defined for the list Inherited from List (PRIM_LIST)
ColumnSortArrowShow the column sort arrow if the primary sort Inherited from List (PRIM_LIST)
ColumnStyleStyle applied to the column heading on mouse down Inherited from List (PRIM_LIST)
ColumnStylesCollection of styles applied to the column heading Inherited from List (PRIM_LIST)
ColumnThemeDrawStyleName of the Theme DrawStyle to be applied to the column headings Inherited from List (PRIM_LIST)
ComponentClassNameComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentControlsComponentControls is a collection of all the controls contained in this component. Inherited from Container (PRIM_CPST)
ComponentMembersComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternNameComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTagGeneric space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentTypeComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeNameComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
CurrentItemBase class for all Prim_List Current Item classes Inherited from List (PRIM_LIST)
CursorCursor sets the cursor image Inherited from Control (PRIM_CTRL)
DataClassReference to a repository field or fundamental product data class used to control data entry
DisplayAlignmentDisplayAlignment sets edit box alignment when not in focus
DisplayPositionDisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL)
DragStyleDragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL)
DropDownCountNumber of items to be shown when the list expands
DropDownOpenReturns true if the dropdown is currently expanded
DropDownStyleDropdown or DropdownList. Dropdown supports editing in the value area, while DropdownList simply shows the list
DropDownWidthWidth of the dropdown area as a percentage of the dropdown
EditAlignmentEditAlignment sets the alignment of the text when in focus
EnableChildrenEnableChildren specifies if the parent sets the Enabled property of child components Inherited from Container (PRIM_CPST)
EnabledEnable activates/deactivates the component Inherited from Control (PRIM_CTRL)
EnterKeyStyleEnterKeyStyle determines what happens when Enter key is pressed in a list Inherited from List (PRIM_LIST)
FixedPositionFix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL)
FocusFocus tells whether the component has focus Inherited from Control (PRIM_CTRL)
FocusColumnReference to the active column in the list Inherited from List (PRIM_LIST)
FocusedStyleReference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusedStylesCollection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusItemReference to the focus item in the list Inherited from List (PRIM_LIST)
HandleReturns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL)
HasSelectionTrue if some of the editable text is selected
HeightThe height of the control in pixels Inherited from Control (PRIM_CTRL)
HintCaption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL)
HintPopupHintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL)
HintShowEnabled or disable the appearance of hints Inherited from Control (PRIM_CTRL)
HintShowOfParentDelegate hints appearance to the parent control Inherited from Control (PRIM_CTRL)
HintTitleHintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL)
HorizontalScrollIncHorizontalScrollInc specifies the pixel increment for horizontal scroll bar. Inherited from List (PRIM_LIST)
HorizontalScrollPosHorizontalScrollPos sets the position of the horizontal scroll bar Inherited from List (PRIM_LIST)
IsAnimatingIsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL)
IsRealizedTrue if the control is currently realized Inherited from Control (PRIM_CTRL)
ItemsCollection of items in the list Inherited from List (PRIM_LIST)
ItemThemeDrawStyleName of the Theme DrawStyle to be applied to the items Inherited from List (PRIM_LIST)
KeyboardPositioningDetermines how the list will position based on keyboard input Inherited from List (PRIM_LIST)
LeftPosition of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL)
ModifiedModified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL)
ModifiedRulesControls when the Modified property is set to True Inherited from List (PRIM_LIST)
MouseOverMouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL)
MouseOverPartTrue if the cursor is within the bounds of a child component Inherited from Container (PRIM_CPST)
MouseOverStyleMouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
MouseOverStylesMouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
NameName identifies the component Inherited from Object (PRIM_OBJT)
NotificationStyleNotificationStyle controls how events are triggered Inherited from List (PRIM_LIST)
OpacityOpacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL)
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
ParentReference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL)
PopupPopup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL)
PopupMenuReference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL)
PrivateStyleStyle applied to the control but not inherited by child controls Inherited from Container (PRIM_CPST)
PrivateStylesCollection of styles applied to the control but not inherited by child controls Inherited from Container (PRIM_CPST)
ReadOnlyReadOnly controls whether a component can be used for input
RotationRotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL)
RotationOriginLeftRotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RotationOriginTopRotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RowHeightHeight of a row in pixels Inherited from List (PRIM_LIST)
RowLinesShow the row separator lines Inherited from List (PRIM_LIST)
RowResizeAllow rows to be resized Inherited from List (PRIM_LIST)
RowSizingDetermines how rows will resize Inherited from List (PRIM_LIST)
ScaleHeightScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScaleOriginLeftScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleOriginTopScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleWidthScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScreenLeftScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL)
ScreenTopScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL)
ScrollLeftLeft position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
ScrollTopTop position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
SelectedRowCountSelectedRowCount shows how many columns have been selected Inherited from List (PRIM_LIST)
SelectionEndPosition in the value that selection ends
SelectionStartPosition in the value that selection starts
SelectionStyleSpecifies the rules for item selection within the list Inherited from List (PRIM_LIST)
ShowSelectionShow selection when the control does not have focus
SkewLeftSkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL)
SkewOriginLeftSkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewOriginTopSkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewTopSkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL)
StyleStyle defines the style to be applied to a control Inherited from Control (PRIM_CTRL)
StylesCollection of styles to be applied to the control Inherited from Control (PRIM_CTRL)
TabPositionTabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL)
TabStopSet to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL)
TextText contains the formatted data currently showing in the edit area
ThemeDrawStyleName of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL)
TopPosition of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL)
TouchMoveDetermines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL)
TouchRotateDetermines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL)
TouchScaleDetermines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL)
TouchSizeDetermines whether a control can be resized Inherited from Control (PRIM_CTRL)
TreeButtonsShow or hide the expand/collapse images Inherited from List (PRIM_LIST)
ValueValue of the data class
VerticalScrollIncVerticalScrollInc specifies the pixel increment for vertical scroll bar. Inherited from List (PRIM_LIST)
VerticalScrollPosVerticalScrollPos sets the position of the vertical scroll bar Inherited from List (PRIM_LIST)
VirtualizationSpecifies if a list is a virtualized. Inherited from List (PRIM_LIST)
VisibleShow or hide the control Inherited from Control (PRIM_CTRL)
VisualStyleVisualStyle sets the appearance Inherited from Control (PRIM_CTRL)
VisualStyleOfParentAdopt the Visual style from the parent control Inherited from Control (PRIM_CTRL)
WidthWidth of the component in pixels Inherited from Control (PRIM_CTRL)

Events

NameDescription
AnimationEndedFired when an animation is ended Inherited from Control (PRIM_CTRL)
Cancelled
AutoCompletingFired as the user enters a value in the edit, allowing for the value to be replaced with a new value
Value, Handled
ChangedChanged is a change in the component Inherited from Control (PRIM_CTRL)
CloseUpFired when the dropdown is closed
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from Control (PRIM_CTRL)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Control (PRIM_CTRL)
DragDropFired on mouse up to signify the end of a drag process Inherited from Control (PRIM_CTRL)
PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult
DragOverFired 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
DropDownFired when the dropdown is opened
Continue
DropDownEditChangedFired when the edit portion of the drop down is changed by the user
DropDownValueChangedFired when the value of the dropdown edit is modified
Item, Value, Image
EndDragFired when the drag and drop process has completed Inherited from Control (PRIM_CTRL)
Source, Payload, DragResult, AggregatedSource, Origin, Handled
EnterFired when the Enter key is pressed Inherited from Control (PRIM_CTRL)
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
GotFocusFired when the control receives the focus Inherited from Control (PRIM_CTRL)
InitializeFired after a component has been realized for the first time Inherited from Control (PRIM_CTRL)
ItemChangedItemChanged happens when an item is changed Inherited from Control (PRIM_CTRL)
Item
ItemClickFired when an item is clicked Inherited from Control (PRIM_CTRL)
Item
ItemCollapsedAn item in the list has collapsed Inherited from Control (PRIM_CTRL)
Item
ItemDoubleClickFired when the user double clicks an item in the list Inherited from Control (PRIM_CTRL)
Item
ItemExpandingAn item in the list is expanding Inherited from Control (PRIM_CTRL)
Item
ItemGotFocusFired when an item receives the focus Inherited from Control (PRIM_CTRL)
Item
ItemGotSelectionFired when an item in the list becomes selected Inherited from Control (PRIM_CTRL)
Item
ItemLostFocusFired when the item loses focus Inherited from Control (PRIM_CTRL)
Item
ItemLostSelectionItemLostSelection happens when another item is selected Inherited from Control (PRIM_CTRL)
Item
ItemMouseEnterThe mouse has entered the bounds of the item Inherited from Control (PRIM_CTRL)
Item
ItemMouseHoverThe mouse is hovering over the item Inherited from Control (PRIM_CTRL)
Item
ItemMouseLeaveThe mouse has left the bounds of the item Inherited from Control (PRIM_CTRL)
Item
ItemRealizingFired when an item design instance is realized, typically when the it comes in to the view port Inherited from Control (PRIM_CTRL)
Item
KeyPressFired when a key is pressed on the keyboard Inherited from Control (PRIM_CTRL)
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
LostFocusLostFocus happens when a component is no longer active Inherited from Control (PRIM_CTRL)
MouseEnterThe mouse has entered the bounds of the control Inherited from Control (PRIM_CTRL)
MouseHoverThe mouse has hovered over the control Inherited from Control (PRIM_CTRL)
Origin, Handled
MouseLeaveThe mouse has left the bounds of the control Inherited from Control (PRIM_CTRL)
ScrollChangedFired when the scrollbars in a composite control are moved Inherited from Control (PRIM_CTRL)
Orientation
StartDragFired when the user starts a drag and drop process Inherited from Control (PRIM_CTRL)
Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled
TouchChangeFired 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
TouchEndFired when the user stops touching the screen Inherited from Control (PRIM_CTRL)
TouchStartFired when the user first makes physical contact with the screen Inherited from Control (PRIM_CTRL)
Origin, TouchMove, TouchRotate, TouchScale, TouchSize

Methods

NameDescription
CloseDropDownForces the listbox portion of the DropDown to be closed
FadeInAnimate from invisible to visible Inherited from Control (PRIM_CTRL)
Duration, Delay
FadeOutAnimate from visible to invisible Inherited from Control (PRIM_CTRL)
Duration, Delay, Visible
FindItemExecutes the OnFind method on the design interface for all list items Inherited from List (PRIM_LIST)
Result, Key, StartItem
FindReferenceFind an object stored as a RelatedReference Inherited from List (PRIM_LIST)
Result, RelatedReference, StartItem
MoveFromMove a control from the specified position to the current position Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
MoveToAnimate a move from the specified number of pixels Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
OpenDropDownForces the listbox portion of a DropDown to be shown
RealizeCreates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
ScaleAnimate a change of scale Inherited from Control (PRIM_CTRL)
ScaleWidth, ScaleHeight, Duration, Delay
SetFocusSets the control to be the focus control Inherited from Control (PRIM_CTRL)
ShowMessagesLANSA Internal Use Inherited from Control (PRIM_CTRL)
TransitionAnimate the change from one control to another Inherited from Container (PRIM_CPST)
From, To, TransitionType, Duration, Delay
UnrealizeDestroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
UpdateDisplayUpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL)
VerticalScrollToSet the vertical scroll position using an item Inherited from List (PRIM_LIST)
Item, ScrollPosition

See also

All Component Classes

Technical Reference

Febuary 18 V14SP2