[Properties (by Name)] [Methods (by Name)] [Events (by Name)]
TFileNameEdit - an EditBox to hold a filename, with an attached SpeedButton that summons a File Open dialog.
Source position: editbtn.pas line 368
type TFileNameEdit = class(TCustomEditButton) |
||
protected |
||
function GetDefaultGlyphName; override; |
|
Gets the default glyph name used for the Button on the control. |
function CreateDialog(); virtual; |
|
Creates the dialog for the control. |
procedure SaveDialogResult(); virtual; |
|
SaveDialogResult - stores the result of the dialog. |
procedure ButtonClick; override; |
|
Performs actions needed when the Button for the control is clicked. |
procedure EditChange; override; |
|
Performs actions needed when the value for the control has been changed. |
procedure DoFolderChange(); virtual; |
|
Signals the OnFolderChange event handler (when assigned). |
public |
||
constructor Create(); override; |
|
Constructor for the class instance. |
destructor Destroy; override; |
|
Destructor for the class instance. |
procedure RunDialog; virtual; |
|
Executes an Open or Save dialog for the DialogKind specified in the control. |
property AutoSelected: Boolean; |
|
|
property DialogFiles: TStrings; [r] |
|
DialogFiles is the list of files for the dialog. |
published |
||
property FileName: string; [rw] |
|
FileName - the name of the selected file: either the initial value placed in the Text Box, or the value selected from the dialog. |
property InitialDir: string; [rw] |
|
InitialDir is the directory from which the search starts. |
property OnAcceptFileName: TAcceptFileNameEvent; [rw] |
|
OnAcceptFileName is an event handler for accepting a filename. |
property OnFolderChange: TNotifyEvent; [rw] |
|
Event handler signalled when the path to FileName has changed. |
property DialogKind: TDialogKind; [rw] |
|
Determines the dialog type executed when the Button in the control is clicked. |
property DialogTitle: string; [rw] |
|
DialogTitle - the title to appear on the dialog. |
property DialogOptions: TOpenOptions; [rw] |
|
DialogOptions - set of options enabled for the file open dialog. |
property Filter: string; [rw] |
|
Filter - the filtering string to help search for the required file. |
property FilterIndex: Integer; [rw] |
|
FilterIndex - index value for the filtering string. |
property DefaultExt: string; [rw] |
|
Default file extension used in the dialog for the component. |
property HideDirectories: Boolean; [rw] |
|
Hides directory paths in the edit control. |
property ButtonCaption: TCaption; |
|
Text displayed on the button for the control. |
property ButtonCursor: TCursor; |
|
Cursor shape displayed when hovering the mouse over the button for the control. |
property ButtonHint: TTranslateString; |
|
Text displayed in the balloon hint for the button in the control. |
property ButtonOnlyWhenFocused: Boolean; |
|
Controls visibility of the Button when the control loses focus. |
property ButtonWidth: Integer; |
|
Width of the Button displayed in the control. |
property Constraints: TSizeConstraints; |
|
Contains the minimum and maximum Width and Height for the control. |
property DirectInput: Boolean; |
|
|
|
Glyph - the small graphic image on the SpeedButton, which ought to indicate its function. |
|
property NumGlyphs: Integer; |
|
NumGlyphs - the number of available glyphs. |
property Images: TCustomImageList; |
|
Contains the Images that can be displayed on the Button for the grouped edit control. |
property ImageIndex: TImageIndex; |
|
Ordinal position in Images for the bitmap displayed on the Button control. |
property ImageWidth: Integer; |
|
Specifies the width of the image displayed on the Button control. |
property Flat: Boolean; |
|
When True, the SpeedButton has a flat appearance rather than a three-dimensional one. |
property FocusOnButtonClick: Boolean; |
|
Indicates if the focus is changed to the Edit control after the Button is clicked. |
|
Specifies the placement of the control on its Parent control. |
|
property Alignment: TAlignment; |
|
|
|
The set of anchor definitions for this control. |
|
property AutoSelect: Boolean; |
|
Enables auto-selection of text when focused. |
property BidiMode: TBiDiMode; |
|
Indicates whether text controls use in bi-directional reading. |
property BorderSpacing: TControlBorderSpacing; |
|
Determines the inner and outer border spacing for this control. |
property BorderStyle: TBorderStyle; |
|
Indicates the border style displayed around the control. |
property AutoSize: Boolean; |
|
Allows automatic adjustment of the size for the control, according to its content. |
|
The background color for the control. |
|
property DragCursor: TCursor; |
|
The cursor shape shown during a drag operation. |
|
Determines how a drag operation is started for the control. |
|
property Enabled: Boolean; |
|
Determines whether the control responds to mouse or keyboard input. |
|
The font to be used for text display in this control. |
|
property Layout: TLeftRight; |
|
|
property MaxLength: Integer; |
|
The maximum length of the value entered in Text, or 0 (zero) for unlimited length. |
property ParentBidiMode: Boolean; |
|
Indicates whether the BiDiMode settings in the Parent control are used. |
property ParentColor: Boolean; |
|
Use the Color from the Parent control, when enabled. |
property ParentFont: Boolean; |
|
Indicates if the Font from the Parent control is used in the control. |
property ParentShowHint: Boolean; |
|
If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True. |
property PopupMenu: TPopupMenu; |
|
A context-sensitive menu that pops up when the right mouse button is clicked over this control. |
property ReadOnly: Boolean; |
|
Indicates if the user is prevented from changing the value for the Text in the control. |
property ShowHint: Boolean; |
|
Enables Hint display for the control. |
property Spacing: Integer; |
|
Specifies the number of pixels reserved between the Edit and Button controls when Button is visible. |
|
Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key. |
|
property TabStop: Boolean; |
|
Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys. |
|
String with the text or caption for the control. |
|
property TextHint: TTranslateString; |
|
|
property Visible: Boolean; |
|
Allows the control, and all of its children, to be displayed or hidden. |
property OnButtonClick: TNotifyEvent; |
|
OnButtonClick - event handler for a mouse click on the SpeedButton. |
property OnChange: TNotifyEvent; |
|
Event handler signalled when the text for the control is changed. |
property OnClick: TNotifyEvent; |
|
Notification handler for mouse clicks. |
property OnContextPopup: TContextPopupEvent; |
|
Invoked when a context-sensitive pop-up menu is requested. |
property OnDblClick: TNotifyEvent; |
|
Event handler signalled when a mouse double click occurs in the control. |
property OnDragDrop: TDragDropEvent; |
|
Event handler signalled when an object is dropped onto the control. |
property OnDragOver: TDragOverEvent; |
|
Event handler signalled when a control is dragged over the control instance. |
property OnEditingDone: TNotifyEvent; |
|
Event handler signalled when editing is completed for the control. |
property OnEndDrag: TEndDragEvent; |
|
Event handler signalled for the end of a drag-drop operation. |
property OnEnter: TNotifyEvent; |
|
Event handler signalled when the control receives focus. |
property OnExit: TNotifyEvent; |
|
Event handler signalled when the control loses focus. |
|
Event handler signalled for key down keyboard events. |
|
property OnKeyPress: TKeyPressEvent; |
|
Event handler signalled for character data entered by the user. |
|
Event handler signalled when a key up event has occurred for the control. |
|
property OnMouseDown: TMouseEvent; |
|
Event handler signalled when a mouse down event is handled for the control. |
property OnMouseEnter: TNotifyEvent; |
|
Event handler signalled when the mouse pointer has entered the control. |
property OnMouseLeave: TNotifyEvent; |
|
Event handler signalled when the mouse pointer has left the control. |
property OnMouseMove: TMouseMoveEvent; |
|
Event handler signalled when the mouse pointer is moved in the control. |
property OnMouseUp: TMouseEvent; |
|
Event handler signalled when a mouse up event is handled for the control. |
property OnMouseWheel: TMouseWheelEvent; |
|
Event handler for mouse wheel turned. |
property OnMouseWheelDown: TMouseWheelUpDownEvent; |
|
Event handler signalled for a downward movement of the mouse wheel. |
property OnMouseWheelUp: TMouseWheelUpDownEvent; |
|
Event handler signalled for an upward movement of the mouse wheel. |
property OnStartDrag: TStartDragEvent; |
|
Event handler signalled for the start of a dragging operation. |
property OnUTF8KeyPress: TUTF8KeyPressEvent; |
|
Handler for a character entered by the user. |
end; |
|
TFileNameEdit - an EditBox to hold a filename, with an attached SpeedButton that summons a File Open dialog. |
|
| | ||
|
TCustomEditButton - base class for TEditButton, an Edit Box with attached Speed Button. |
|
| | ||
|
||
| | ||
|
The base class for windowed controls which paint themselves. |
|
| | ||
|
Implements a windowed control which can contain other child controls. |
|
| | ||
|
The base class for visible controls. |
|
| | ||
|
||
| | ||
TObject |
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.
|
TCustomEditButton - base class for TEditButton, an Edit Box with attached Speed Button. |
CT Web help |
CodeTyphon Studio |