TFileNameEdit class
TFileNameEdit - an EditBox to hold a filename, with an attached
SpeedButton that summons a File Open dialog.Declaration
TFileNameEdit = class(TCustomEditButton)Inheritance
- TFileNameEdit
- TCustomEditButton
- TCustomAbstractGroupedEdit
- TCustomControl
- TWinControl
- TControl
- TLCLComponent
- TComponent
- TPersistent
- TObject
Description
TFileNameEdit is a
TCustomEditButton descendant which
implements a grouped edit control used to select and edit a file name on the
local file system. The control provides the Edit and Button properties from
the ancestor class, and executes a dialog when the Button is clicked. New
properties are introduced which allow configuring the control to a specific
file path, filters to select files of particular type or file extension, and
to hide or show directories in its dialog.
See also
Properties
AutoSelected | public | Indicates if the current text selection was performed automatically. |
DialogFiles | public | DialogFiles is the list of files for the dialog. |
FileName | published | FileName - the name of the selected file: either the initial value placed in the Text Box, or the value selected from the dialog. |
InitialDir | published | Initial directory displayed when the dialog is executed for the control. |
DialogKind | published | Determines the dialog type executed when the Button in the control is clicked. |
DialogTitle | published | DialogTitle - the title to appear on the dialog. |
DialogOptions | published | DialogOptions - set of options enabled for the file open dialog. |
DialogOptionsEx | published | |
Filter | published | Filter - the filtering string to help search for the required file. |
FilterIndex | published | FilterIndex - index value for the filtering string. |
DefaultExt | published | Default file extension used in the dialog for the component. |
HideDirectories | published | Hides directory paths in the edit control. |
ButtonCaption | published | Text displayed on the button for the control. |
ButtonCursor | published | Cursor shape displayed when hovering the mouse over the button for the control. |
ButtonHint | published | Text displayed in the balloon hint for the button in the control. |
ButtonOnlyWhenFocused | published | Controls visibility of the Button when the control loses focus. |
ButtonWidth | published | Width of the Button displayed in the control. |
Constraints | published | Contains the minimum and maximum Width and Height for the control. |
DirectInput | published | Indicates if text can be entered directly into the BaseEditor control. |
Glyph | published | Glyph - the small graphic image on the SpeedButton, which ought to indicate its function. |
NumGlyphs | published | NumGlyphs - the number of available glyphs. |
Images | published | Contains the Images that can be displayed on the Button for the grouped edit control. |
ImageIndex | published | Ordinal position in Images for the bitmap displayed on the Button control. |
ImageWidth | published | Specifies the width of the image displayed on the Button control. |
Flat | published | When True, the SpeedButton has a flat appearance rather than a three-dimensional one. |
FocusOnButtonClick | published | Indicates if the focus is changed to the Edit control after the Button is clicked. |
Align | published | Specifies the placement of the control on its Parent control. |
Alignment | published | Indicates the text alignment used for the control value. |
Anchors | published | The set of anchor definitions for this control. |
AutoSelect | published | Enables auto-selection of text when focused. |
BidiMode | published | Indicates whether text controls use in bi-directional reading. |
BorderSpacing | published | Determines the inner and outer border spacing for this control. |
BorderStyle | published | Indicates the border style displayed around the control. |
AutoSize | published | Allows automatic adjustment of the size for the control, according to its content. |
Color | published | The background color for the control. |
DragCursor | published | The cursor shape shown during a drag operation. |
DragMode | published | Determines how a drag operation is started for the control. |
Enabled | published | Determines whether the control responds to mouse or keyboard input. |
Font | published | The font to be used for text display in this control. |
Layout | published | Controls the alignment of the edit control and its associate. |
MaxLength | published | The maximum length of the value entered in Text, or 0 (zero) for unlimited length. |
ParentBidiMode | published | Indicates whether the BiDiMode settings in the Parent control are used. |
ParentColor | published | Use the Color from the Parent control, when enabled. |
ParentFont | published | Indicates if the Font from the Parent control is used in the control. |
ParentShowHint | published | If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True. |
PopupMenu | published | A context-sensitive menu that pops up when the right mouse button is clicked over this control. |
ReadOnly | published | Indicates if the user is prevented from changing the value for the Text in the control. |
ShowHint | published | Enables Hint display for the control. |
Spacing | published | Specifies the number of pixels reserved between the Edit and Button controls when Button is visible. |
TabOrder | published | Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key. |
TabStop | published | Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys. |
Text | published | String with the text or caption for the control. |
TextHint | published | Default hint text shown when the Text property is empty for the grouped edit control. |
Visible | published | Allows the control, and all of its children, to be displayed or hidden. |
Methods
GetDefaultGlyphName | protected | Gets the default glyph name used for the Button on the control. |
CreateDialog | protected | Creates the dialog for the control. |
SaveDialogResult | protected | SaveDialogResult - stores the result of the dialog. |
ButtonClick | protected | Performs actions needed when the Button for the control is clicked. |
EditChange | protected | Performs actions needed when the value for the control has been changed. |
DoFolderChange | protected | Signals the OnFolderChange event handler (when assigned). |
Create | public | Constructor for the class instance. |
Destroy | public | Destructor for the class instance. |
RunDialog | public | Executes an Open or Save dialog for the DialogKind specified in the control. |
Events
OnAcceptFileName | published | OnAcceptFileName is an event handler for accepting a filename. |
OnFolderChange | published | Event handler signalled when the path to FileName has changed. |
OnButtonClick | published | OnButtonClick - event handler for a mouse click on the SpeedButton. |
OnChange | published | Event handler signalled when the text for the control is changed. |
OnClick | published | Notification handler for mouse clicks. |
OnContextPopup | published | Invoked when a context-sensitive pop-up menu is requested. |
OnDblClick | published | Event handler signalled when a mouse double click occurs in the control. |
OnDragDrop | published | Event handler signalled when an object is dropped onto the control. |
OnDragOver | published | Event handler signalled when a control is dragged over the control instance. |
OnEditingDone | published | Event handler signalled when editing is completed for the control. |
OnEndDrag | published | Event handler signalled for the end of a drag-drop operation. |
OnEnter | published | Event handler signalled when the control receives focus. |
OnExit | published | Event handler signalled when the control loses focus. |
OnKeyDown | published | Event handler signalled for key down keyboard events. |
OnKeyPress | published | Event handler signalled for character data entered by the user. |
OnKeyUp | published | Event handler signalled when a key up event has occurred for the control. |
OnMouseDown | published | Event handler signalled when a mouse down event is handled for the control. |
OnMouseEnter | published | Event handler signalled when the mouse pointer has entered the control. |
OnMouseLeave | published | Event handler signalled when the mouse pointer has left the control. |
OnMouseMove | published | Event handler signalled when the mouse pointer is moved in the control. |
OnMouseUp | published | Event handler signalled when a mouse up event is handled for the control. |
OnMouseWheel | published | Event handler for mouse wheel turned. |
OnMouseWheelDown | published | Event handler signalled for a downward movement of the mouse wheel. |
OnMouseWheelUp | published | Event handler signalled for an upward movement of the mouse wheel. |
OnStartDrag | published | Event handler signalled for the start of a dragging operation. |
OnUTF8KeyPress | published | Handler for a character entered by the user. |
Inherited
From TCustomEditButton (11)
BuddyClick Button CalcButtonVisible CalculatePreferredSize CheckButtonVisible Edit GetBuddyClassType GetControlClassDefaultSize GetEditorClassType GlyphChanged LoadDefaultGlyph
From TCustomAbstractGroupedEdit (87)
AutoSizeHeightIsEditHeight BaseEditor Buddy BuddyCaption BuddyCursor BuddyHint BuddyWidth CanUndo CaretPos CharCase CheckCursor Clear ClearSelection CMParentColorChanged CopyToClipboard CreateBuddy CreateEditor CutToClipboard DoEnter EchoMode EditCanModify EditClick EditContextPopup EditDblClick EditDragDrop EditDragOver EditEditingDone EditEndDrag EditEnter EditExit EditKeyDown EditKeyPress EditKeyUp EditMask EditMouseDown EditMouseEnter EditMouseLeave EditMouseMove EditMouseUp EditMouseWheel EditMouseWheelDown EditMouseWheelUp EditStartDrag EditText EditUtf8KeyPress FocusAndMaybeSelectAll Focused FocusOnBuddyClick GetBuddyCaption GetBuddyCursor GetBuddyHint GetBuddyVisible GetBuddyWidth GetEditPopupMenu GetSel GetSpacing HideSelection IsMasked Loaded Modified NumbersOnly OnBuddyClick PasswordChar PasteFromClipboard RealGetText RealSetText Reset SelectAll SelLength SelStart SelText SetAutoSize SetBuddyCaption SetBuddyCursor SetBuddyHint SetBuddyVisible SetBuddyWidth SetColor SetCursor SetDirectInput SetFocus SetSel ShouldAutoAdjust Undo UpdateSpacing ValidateEdit WSRegisterClass
From TCustomControl (7)
Canvas DestroyWnd FontChanged OnPaint Paint PaintWindow WMPaint
From TWinControl (222)
AddControl AdjustClientRect AlignControls AllAutoSized AutoAdjustLayout AutoSizeDelayed AutoSizeDelayedHandle AutoSizeDelayedReport AutoSizePhases BeginUpdateBounds BorderWidth BoundsLockCount BroadCast Brush BrushCreated CachedClientHeight CachedClientWidth CanFocus CanSetFocus CanTab ChangeScale ChildClassAllowed ChildHandlesCreated ChildKey ChildSizing ClientRectNeedsInterfaceUpdate CMBiDiModeChanged CMBorderChanged CMDoubleBufferedChanged CMEnabledChanged CMEnter CMExit CMParentDoubleBufferedChanged CMShowHintChanged CMShowingChanged CMVisibleChanged CNChar CNKeyDown CNKeyUp CNSysKeyDown CNSysKeyUp ContainsControl ControlAtPos ControlCount ControlKeyDown ControlKeyUp Controls ControlsAligned CreateBrush CreateDockManager CreateHandle CreateParams CreateParented CreateParentedControl CreateSubClass CreateWnd CustomAlignInsertBefore CustomAlignPosition DefaultHandler DefWndProc DesignerDeleting DestroyHandle DialogChar DisableAlign DoAddDockClient DoAdjustClientRectChange DoAlignChildControls DoAllAutoSize DoAutoSize DoChildSizingChange DockClientCount DockClients DockDrop DockManager DockOver DockSite DoConstraintsChange DoDockClientMsg DoDockOver DoDragMsg DoExit DoFlipChildren DoFloatMsg DoGetDockCaption DoKeyDownBeforeInterface DoKeyPress DoKeyUpBeforeInterface DoRemainingKeyDown DoRemainingKeyUp DoRemoveDockClient DoSendBoundsToInterface DoSendShowHideToInterface DoSetBounds DoubleBuffered DoUnDock DoUndockClientMsg DoUTF8KeyPress EnableAlign EndUpdateBounds EraseBackground FinalizeWnd FindChildControl FindNextControl FixDesignFontsPPIWithChildren FixupTabList FlipChildren FormEndUpdated GetAdjustedLogicalClientRect GetBorderStyle GetChildren GetChildrenRect GetClientOrigin GetClientRect GetControlIndex GetControlOrigin GetDeviceContext GetDockCaption GetEnumeratorControls GetEnumeratorControlsReverse GetMouseCapture GetParentHandle GetPreferredSizeClientFrame GetSiteInfo GetTabOrderList GetTextLen GetTopParentHandle Handle HandleAllocated HandleNeeded InitializeWnd InsertControl IntfGetDropFilesTarget IntfUTF8KeyPress Invalidate InvalidateBoundsRealized InvalidateClientRectCache InvalidatePreferredChildSizes IsClientHeightStored IsClientWidthStored IsControlMouseMsg IsFlipped IsResizing IsSpecialSubControl KeyDown KeyDownAfterInterface KeyDownBeforeInterface KeyPress KeyUp KeyUpAfterInterface KeyUpBeforeInterface LockRealizeBounds MainWndProc NotifyControls OnAlignInsertBefore OnAlignPosition OnDockDrop OnDockOver OnGetDockCaption OnGetSiteInfo OnUnDock PaintControls PaintHandler PaintTo ParentDoubleBuffered ParentFormHandleInitialized ParentHandlesAllocated ParentWindow PerformTab ReAlign RealizeBounds RealizeBoundsRecursive ReloadDockedControl RemoveControl RemoveFocus Repaint ScaleBy ScaleControls ScrollBy ScrollBy_WS SelectFirst SelectNext SendDialogChar SendMoveSizeMessages SetBorderStyle SetBounds SetChildZPosition SetControlIndex SetDockManager SetShape SetTempCursor ShowControl Showing UnlockRealizeBounds Update UpdateControlState UpdateDockCaption UpdateShowing UseDockManager UTF8KeyPress VisibleDockClientCount WindowHandle WMChar WMContextMenu WMDestroy WMEnter WMEraseBkgnd WMExit WMKeyDown WMKeyUp WMKillFocus WMMove WMNotify WMSetFocus WMShowWindow WMSize WMSysChar WMSysKeyDown WMSysKeyUp WMWindowPosChanged WndProc WriteLayoutDebugReport WSSetText
From TControl (327)
AccessibleDescription AccessibleName AccessibleRole AccessibleValue Action ActionChange ActionLink ActiveDefaultControlChanged AddHandler AddHandlerOnBeforeDestruction AddHandlerOnChangeBounds AddHandlerOnEnabledChanged AddHandlerOnEnabledChanging AddHandlerOnKeyDown AddHandlerOnMouseWheel AddHandlerOnResize AddHandlerOnVisibleChanged AddHandlerOnVisibleChanging AdjustSize AnchorAsAlign AnchorClient AnchoredControlCount AnchoredControls AnchorHorizontalCenterTo AnchorParallel AnchorSame AnchorSide AnchorSideBottom AnchorSideChanged AnchorSideLeft AnchorSideRight AnchorSideTop AnchorToCompanion AnchorToNeighbour AnchorVerticalCenterTo AssignTo AutoSizing AutoSizingAll AutoSizingLockCount BaseBounds BaseParentClientSize BeforeDestruction BeforeDragStart BeginAutoDrag BeginAutoSizing BeginDrag BoundsChanged BoundsRect BoundsRectForNewParent BringToFront CalculateDockSizes CanAutoSize Caption CaptureChanged CaptureMouseButtons ChangeBounds Changed CheckChildClassAllowed CheckNewParent CheckOnChangeBounds Click ClientHeight ClientOrigin ClientRect ClientToParent ClientToScreen ClientWidth CMChanged CMCursorChanged CMHintShow CMHitTest CMMouseEnter CMMouseLeave CMParentBiDiModeChanged CMParentFontChanged CMParentShowHintChanged CMSysFontChanged CMTextChanged CNPreferredSizeChanged ColorIsStored ConstrainedResize ControlFontClass ControlOrigin ControlState ControlStyle ControlToScreen CreateAccessibleObject CreateControlBorderSpacing CreateFloatingDockSite Cursor DblClick DefineProperties DesktopFont DisableAutoSizing DoAutoAdjustLayout DoBorderSpacingChange DoCallKeyEventHandler DoCallMouseWheelEventHandler DoCallNotifyHandler Dock Docked DockOrientation DockTrackNoTarget DoContextPopup DoDock DoEndDock DoEndDrag DoFixDesignFontPPI DoMouseDown DoMouseUp DoMouseWheel DoMouseWheelDown DoMouseWheelHorz DoMouseWheelLeft DoMouseWheelRight DoMouseWheelUp DoOnChangeBounds DoOnParentHandleDestruction DoOnResize DoOnShowHint DoScaleFontPPI DoStartDock DoStartDrag DragCanceled DragDrop Dragging DragKind DragOver EditingDone EnableAutoSizing EnabledChanged EnabledChanging EndAutoSizing EndDrag ExecuteCancelAction ExecuteDefaultAction FindSubComponent FixDesignFontsPPI Floating FloatingDockSiteClass ForeignAnchorSideChanged FormIsUpdating GetAccessibleObject GetAction GetActionLinkClass GetAnchorsDependingOnParent GetCachedText GetCanvasScaleFactor GetChildAccessibleObjectAtPos GetClientScrollOffset GetColorResolvingParent GetCursor GetDefaultColor GetDefaultDockCaption GetDefaultHeight GetDefaultWidth GetDockEdge GetDragImages GetEnabled GetFloating GetFloatingDockSiteClass GetLogicalClientRect GetMousePosFromMessage GetPalette GetParentBackground GetParentComponent GetPopupMenu GetPreferredSize GetRGBColorResolvingParent GetScrolledClientRect GetSelectedChildAccessibleObject GetSidePosition GetTextBuf GetTopParent HandleObjectShouldBeVisible HasHelp HasParent Height HeightIsAnchored HelpContext HelpKeyword HelpType Hide Hint HostDockSite InitiateAction InvalidateControl InvalidatePreferredSize IsAParentAligning IsBorderSpacingInnerBorderStored IsCaptionStored IsControl IsControlVisible IsEnabled IsParentColor IsParentFont IsParentOf IsProcessingPaintMsg IsRightToLeft IsVisible Left LMCaptureChanged LoadedAll LRDockWidth ManualDock ManualFloat MouseCapture MouseDown MouseEnter MouseInClient MouseLeave MouseMove MouseUp Notification OnChangeBounds OnConstrainedResize OnEndDock OnMouseWheelHorz OnMouseWheelLeft OnMouseWheelRight OnQuadClick OnResize OnShowHint OnStartDock OnTripleClick Parent ParentBackground ParentDestroyingHandle ParentFontChanged ParentToClient Perform PositionDockRect QuadClick ReadBounds ReadState Refresh RemoveAllHandlersOfObject RemoveHandler RemoveHandlerOnBeforeDestruction RemoveHandlerOnChangeBounds RemoveHandlerOnEnabledChanged RemoveHandlerOnEnabledChanging RemoveHandlerOnKeyDown RemoveHandlerOnMouseWheel RemoveHandlerOnResize RemoveHandlerOnVisibleChanged RemoveHandlerOnVisibleChanging ReplaceDockedControl RequestAlign Resize Scale96ToFont Scale96ToForm Scale96ToScreen ScaleConstraints ScaleDesignToForm ScaleFontsPPI ScaleFontTo96 ScaleFontToScreen ScaleFormTo96 ScaleFormToDesign ScaleScreenTo96 ScaleScreenToFont ScreenToClient ScreenToControl SendToBack SessionProperties SetAction SetAlign SetAnchors SetBiDiMode SetBoundsKeepBase SetDragMode SetEnabled SetHint SetInitialBounds SetName SetParent SetParentBackground SetParentBiDiMode SetParentComponent SetTextBuf SetVisible SetZOrder Show ShowHelp TBDockHeight TextChanged Top TripleClick UndockHeight UndockWidth UpdateAnchorRules UpdateBaseBounds UpdateMouseCursor UpdateRolesForForm UseRightToLeftAlignment UseRightToLeftReading UseRightToLeftScrollBar VisibleChanged VisibleChanging Width WidthIsAnchored WindowProc WMCancelMode WMLButtonDBLCLK WMLButtonDown WMLButtonQuadCLK WMLButtonTripleCLK WMLButtonUp WMMButtonDBLCLK WMMButtonDown WMMButtonQuadCLK WMMButtonTripleCLK WMMButtonUp WMMouseHWheel WMMouseMove WMMouseWheel WMRButtonDBLCLK WMRButtonDown WMRButtonQuadCLK WMRButtonTripleCLK WMRButtonUp WMXButtonDBLCLK WMXButtonDown WMXButtonQuadCLK WMXButtonTripleCLK WMXButtonUp
From TLCLComponent (6)
DecLCLRefCount GetWSComponentClass IncLCLRefCount LCLRefCount NewInstance WidgetSetClass
From TComponent (64)
_AddRef _Release CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetTypeInfo GetTypeInfoCount iicrGetComponent InsertComponent Invoke IsImplementorOf Loading Name ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState
From TPersistent (4)
Assign FPOAttachObserver FPODetachObserver FPONotifyObservers
From TObject (35)
AfterConstruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName
An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.
