PRIM_MD.FilePicker (PRIM_MD.FilePicker)

Show explorer to select a file

Ancestors - Label (PRIM_MD.Label) Control (PRIM_MD.Control) Control (PRIM_CTRL) Object (PRIM_OBJT)

Details

The Web FilePicker Control provides allows the application to prompt the user for a local file.

Example

This example shows file picker, in this case made to look like a button, prompting for a file. Once picked, the file is shown on the screen.
    Begin_Com Role(*EXTENDS #PRIM_WEB) Layoutmanager(#TableLayout1)
 
       Define_Com Class(#PRIM_VS.Style) Name(#Style2) Fontsize(14)
 
       Define_Com Class(#PRIM_TBLO) Name(#TableLayout1)
       Define_Com Class(#PRIM_TBLO.Column) Name(#Column1) Displayposition(1) Parent(#TableLayout1) Width(185) Units(Pixels)
       Define_Com Class(#PRIM_TBLO.Column) Name(#Column2) Displayposition(2) Parent(#TableLayout1) Width(1.7)
       Define_Com Class(#PRIM_TBLO.Row) Name(#Row1) Displayposition(1) Parent(#TableLayout1)
       Define_Com Class(#PRIM_TBLO.Item) Name(#FilePicker1Item1) Alignment(TopCenter) Column(#Column1) Manage(#FilePicker) Parent(#TableLayout1) Row(#Row1) Sizing(None) Margintop(6)
       Define_Com Class(#PRIM_TBLO.Item) Name(#Image1Item1) Column(#Column2) Manage(#Image) Parent(#TableLayout1) Row(#Row1) Margintop(6) Marginright(6) Marginbottom(6) Marginleft(6)
       Define_Com Class(#PRIM_TBLO.Item) Name(#Label1Item1) Alignment(BottomCenter) Column(#Column2) Manage(#Filename) Parent(#TableLayout1) Row(#Row1) Sizing(FitToWidth) Marginbottom(12) Marginright(12) Marginleft(12)
 
       Define_Com Class(#PRIM_MD.FilePicker) Name(#FilePicker) Parent(#COM_OWNER) Displayposition(3) Left(42) Tabposition(3) Top(6) Icon('attach_file')
       Define_Com Class(#PRIM_IMAG) Name(#Image) Displayposition(3) Left(191) Parent(#COM_OWNER) Tabposition(2) Tabstop(False) Top(6) Height(788) Width(1003)
       Define_Com Class(#PRIM_LABL) Name(#Filename) Displayposition(1) Ellipses(Word) Height(55) Left(197) Parent(#COM_OWNER) Tabposition(3) Tabstop(False) Top(733) Verticalalignment(Center) Width(991) Alignment(Center) Style(#Style2)
 
       Evtroutine Handling(#FilePicker.FileSelected) File(#File)
 
          #Filename := #File.Name
          #Image.FileName := #File.Blob
 
       Endroutine
 
    End_Com

Properties

NameDescription
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)
CaptionText to be displayed within the label Inherited from Label (PRIM_MD.Label)
CaptionAlignmentPosition of the caption within the control Inherited from Label (PRIM_MD.Label)
CaptionMarginBottomBottom margin in pixels Inherited from Label (PRIM_MD.Label)
CaptionMarginLeftLeft margin in pixels Inherited from Label (PRIM_MD.Label)
CaptionMarginRightRight margin in pixels Inherited from Label (PRIM_MD.Label)
CaptionMarginTopTop margin in pixels Inherited from Label (PRIM_MD.Label)
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)
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)
EllipsesShow ellipses for truncated text Inherited from Label (PRIM_MD.Label)
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)
HandleReturns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL)
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)
IconImage displayed within the control Inherited from Label (PRIM_MD.Label)
IconAlignmentPosition of the icon within the control Inherited from Label (PRIM_MD.Label)
IconColorColor to be applied to the icon Inherited from Label (PRIM_MD.Label)
IconFileNameFileName is the name of image file Inherited from Label (PRIM_MD.Label)
IconHeightHeight of the icon in pixels Inherited from Label (PRIM_MD.Label)
IconImageMaterial design image to show on the control Inherited from Label (PRIM_MD.Label)
IconImageSizingSpecifies the sizing behaviour of the IconImage Inherited from Label (PRIM_MD.Label)
IconMarginBottomBottom margin in pixels Inherited from Label (PRIM_MD.Label)
IconMarginLeftLeft margin in pixels Inherited from Label (PRIM_MD.Label)
IconMarginRightRight margin in pixels Inherited from Label (PRIM_MD.Label)
IconMarginTopTop margin in pixels Inherited from Label (PRIM_MD.Label)
IconOpacityPercentage opacity of the icon Inherited from Label (PRIM_MD.Label)
IconPaddingPadding of the icon in pixels Inherited from Label (PRIM_MD.Label)
IconThemeDrawStyleName of the Theme DrawStyle to be applied to the icon Inherited from Label (PRIM_MD.Label)
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)
LeftPosition of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL)
Link[MISSING] Inherited from Label (PRIM_MD.Label)
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)
MultiSelectAllow multiple files to be selected
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)
PaddingBottomBottom padding in pixels Inherited from Label (PRIM_MD.Label)
PaddingLeftLeft padding in pixels Inherited from Label (PRIM_MD.Label)
PaddingRightRight padding in pixels Inherited from Label (PRIM_MD.Label)
PaddingTopTop padding in pixels Inherited from Label (PRIM_MD.Label)
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)
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)
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)
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)
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)
WordWrapWrap text on to the next line if there is insufficient space Inherited from Label (PRIM_MD.Label)

Events

NameDescription
AnimationEndedFired when an animation is ended Inherited from Label (PRIM_MD.Label)
Cancelled
ClickFired when the mouse is clicked on the control Inherited from Label (PRIM_MD.Label)
Origin, Handled
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from Label (PRIM_MD.Label)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Label (PRIM_MD.Label)
DragDropFired on mouse up to signify the end of a drag process Inherited from Label (PRIM_MD.Label)
PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult
DragOverFired during the drag and drop process when the cursor moves over the control Inherited from Label (PRIM_MD.Label)
PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled
EndDragFired when the drag and drop process has completed Inherited from Label (PRIM_MD.Label)
Source, Payload, DragResult, AggregatedSource, Origin, Handled
FileSelectedFired when a file is selected
File, Files
InitializeFired after a component has been realized for the first time Inherited from Label (PRIM_MD.Label)
MouseEnterThe mouse has entered the bounds of the control Inherited from Label (PRIM_MD.Label)
MouseHoverThe mouse has hovered over the control Inherited from Label (PRIM_MD.Label)
Origin, Handled
MouseLeaveThe mouse has left the bounds of the control Inherited from Label (PRIM_MD.Label)
StartDragFired when the user starts a drag and drop process Inherited from Label (PRIM_MD.Label)
Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled
TouchChangeFired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events Inherited from Label (PRIM_MD.Label)
MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue
TouchEndFired when the user stops touching the screen Inherited from Label (PRIM_MD.Label)
TouchStartFired when the user first makes physical contact with the screen Inherited from Label (PRIM_MD.Label)
Origin, TouchMove, TouchRotate, TouchScale, TouchSize

Methods

NameDescription
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
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)
SizeToChanges and animates control size changing 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

LANSA Version 15, April 2020