DropDown (PRIM_MD.Dropdown)

Dropdown

Ancestors - Field (PRIM_MD.Input) Control (PRIM_MD.Control) 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 entry will be returned to the parent component.

Example

In this example a dropdown is populated with 3 different values.
Begin_Com Role(*EXTENDS #PRIM_WEB) Theme(#SYS_THEME)

    Define_Com Class(#PRIM_MD.Dropdown) Name(#DropDown) Caption('My Drop Down') Displayposition(1) Left(140) Parent(#COM_OWNER) Tabposition(1) Top(75) Width(261)

        Evtroutine Handling(#COM_OWNER.Initialize)

            #DropDown.Items.Add( "Value 1" )
            #DropDown.Items.Add( "Value 2" )
            #DropDown.Items.Add( "Value 3" )

        Endroutine
End_Com

Properties

NameDescription
AppearanceFormat of the control Inherited from Field (PRIM_MD.Input)
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)
CaptionCaption property Inherited from Field (PRIM_MD.Input)
CaptionColorColor of caption Inherited from Field (PRIM_MD.Input)
CaptionPositionSets the position of Caption Inherited from Field (PRIM_MD.Input)
ClearButtonSpecifies if clear button is displayed on control
ComponentClassNameComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
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)
CursorCursor sets the cursor image Inherited from Control (PRIM_CTRL)
DisplayAlignmentDisplayAlignment sets the text 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)
EditAlignmentEditAlignment sets the alignment of the text when in focus
EnabledEnable activates/deactivates the component Inherited from Control (PRIM_CTRL)
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)
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
HandleReturns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL)
HasErrorIs the field flagged as being in error Inherited from Field (PRIM_MD.Input)
HasSelectionTrue if some of the editable text is selected
HeightThe height of the control in pixels Inherited from Control (PRIM_CTRL)
HelperColorColor of helper text Inherited from Field (PRIM_MD.Input)
HelperPositionPosition where the helper text will be displayed Inherited from Field (PRIM_MD.Input)
HelperTextText to show in the Helper area of the field Inherited from Field (PRIM_MD.Input)
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)
IconImage displayed within the button Inherited from Field (PRIM_MD.Input)
IconColorColor to be applied to the icon Inherited from Field (PRIM_MD.Input)
IconFileNameFileName is the name of image file Inherited from Field (PRIM_MD.Input)
IconHeightHeight of the icon in pixels Inherited from Field (PRIM_MD.Input)
IconImageMaterial design image to show on the control Inherited from Field (PRIM_MD.Input)
IconImageSizingSpecifies the sizing behaviour of the IconImage Inherited from Field (PRIM_MD.Input)
IconOpacityPercentage opacity of the icon Inherited from Field (PRIM_MD.Input)
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
LeftPosition of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL)
MaxLengthMaxLength sets the maximum number of characters
ModifiedModified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL)
MouseOverMouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL)
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)
MultiLineAllow text to wrap to a new line
NameName identifies the component Inherited from Object (PRIM_OBJT)
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)
PasswordCharCharacter to use to mask the data being entered
PlaceholderText to be shown when the edit has no value Inherited from Field (PRIM_MD.Input)
PlaceholderColorColor of the placeholder text Inherited from Field (PRIM_MD.Input)
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)
PromptOnlyOnly allow input via the prompter
PromptPositionPosition of the prompter
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)
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)
SelectionEndPosition in the value that selection ends
SelectionStartPosition in the value that selection starts
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)
SpellCheckUse browser spell checking features
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)
ThemeBackgroundBackground theme to be used Inherited from Control (PRIM_MD.Control)
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)
ValueValue of the dropdown
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 a value is being edited allowing for a replacement value to be returned
Value, Handled
AutoSuggestFired when the value is changed after a short delay
ChangedFired when the value is changed
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
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
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
GotFocusFired when the control receives the focus
IconClickFired when the icon is clicked Inherited from Control (PRIM_CTRL)
Origin, Handled
InitializeFired after a component has been realized for the first time Inherited from Control (PRIM_CTRL)
KeyPressFired when a key is pressed on the keyboard
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
LostFocusFired when the control loses focus
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)
PromptingFired when prompt icon is pressed
Origin, Handled
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
ClearErrorClear the error Inherited from Field (PRIM_MD.Input)
CloseDropDownForces the list 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
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 list 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
SelectTextSet selection within the value
StartPosition, Length
SetFocusSets the control to be the focus control Inherited from Control (PRIM_CTRL)
ShowErrorSet the field in error Inherited from Field (PRIM_MD.Input)
ErrorText
ShowMessagesLANSA Internal Use Inherited from Control (PRIM_CTRL)
SizeTo Inherited from Control (PRIM_CTRL)
Width, Height, 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)

See also

All Component Classes

Technical Reference

EPC1420030 V14sp2 November 2018