JamControls.TJamPathEdit

Simple component that displays a path or folder , which before has been selected in a dialog, in an editfield.

Syntax

Pascal

TJamPathEdit = class(TCustomPanel);

Remarks

The JamPathLabel is a simple component that allows the user to enter a path or to browse for it. The user can open a browse dialog by pressing the button on the right. Use the Path property to set a default path or to get the path that the user has finally chosen. Use The FolderMode property to define if the user should enter / browse for a path to a file or a folder.

Namespace

JamControls

Public Methods

	Name	Description
	constructor Create(AOwner: TComponent); override;	Creates an instance of a TJamPathEdit component
	destructor Destroy; override;	Destroys an instance of a TJamPathEdit component

TJamPathEdit Events

	Name	Description
	property OnButtonClick: TPathBrowserOpenEvent read fButtonClick write fButtonClick;	Event that is fired when the user clicks the button the opens the dialog for path browsing.

TJamPathEdit Methods

	Name	Description
	function CheckFilter: Boolean;	Checks if the Path matches the given FileFilter.
	procedure SetFocus; override;	See TCustomPanel.SetFocus

TJamPathEdit Properties

	Name	Description
	property Align;	Determines how the control aligns within its container (parent control).
	property Anchors;	Specifies how the control is anchored to its parent.
	property AutoSize;	Specifies whether the control sizes itself automatically to accommodate its contents.
	property BevelEdges;	Specifies which edges of the control are beveled.
	property BevelInner;	Specifies the cut of the inner bevel.
	property BevelKind;	Specifies the control's bevel style.
	property BevelOuter default bvNone;	Specifies the cut of the outer bevel.
	property BorderStyle;	Determines whether the list view displays a single line border.
	property Color: TColor read GetColor write SetColor default clWindow;	Changes the window title of the opendialog.
	property Constraints;	Specifies the size constraints for the control.
	property DefaultExt: UnicodeString read fDefaultExt write SetDefaultExt;	Specifies a default file extension.
	property DialogButtonCaption: UnicodeString read fDialogButtonCaption write SetDialogButtonCaption;	Text of the Open button.
	property DialogTitle: UnicodeString read FDialogTitle write SetDialogTitle;	Changes the window title of the opendialog
	property DoubleBuffered;	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
	property DragCursor;	Specifies the image used to represent the mouse pointer when the control is being dragged.
	property DragKind;	Specifies whether the control is being dragged normally or for docking.
	property DragMode;	Specifies the image used to represent the mouse pointer when the control is being dragged.
	property Enabled;	Controls whether the control responds to mouse, keyboard, and timer events.
	property FileFilter: UnicodeString read fFileFilter write fFileFilter;	Edit the filter of the opendialog.
	property FolderMode: boolean read FFolderMode write SetFolderMode default false;	Use this property to select if the dialog for browsing for a file, or for a folder should be displayed.
	property Font;	Controls the attributes of text written on or in the control. Make sure to turn off UseSystemFont before editing this control! Otherwise the changes will not persist.
	property InitialDialogPath: UnicodeString read fInitialDialogPath write fInitialDialogPath;	Gives an initial directory for the shown dialog.
	property IsValidPath: Boolean read GetIsValidPath;	Property to check the selection
	property OnCanResize;	Occurs when an attempt is made to resize the control.
	property OnChange: TNotifyEvent read fOnchange write fOnChange;	This event will be triggered whenever something in the edit field changes.
	property OnClick;	Occurs when the user clicks the control.
	property OnDblClick;	Occurs when the user double-clicks the left mouse button when the mouse pointer is over the control.
	property OnDragDrop;	Occurs when the user drops an object being dragged.
	property OnDragOver;	Occurs when the user drags an object over a control.
	property OnEnter;	Occurs when a control receives the input focus.
	property OnExit;	Occurs when the input focus shifts away from one control to another.
	property OnKeyDown: TKeyEvent read fOnKeyDown write fOnKeyDown;	Occurs when a user presses any key while the control has focus.
	property OnKeyPress: TKeyPressEvent read fOnKeyPress write fOnKeyPress;	Occurs when a key is pressed.
	property OnKeyUp: TKeyEvent read fOnKeyUp write fOnKeyUp;	Occurs when the user releases a key that was pressed.
	property OnMouseDown;	Occurs when the user presses a mouse button with the mouse pointer over a control.
	property OnMouseMove;	Occurs when the user moves the mouse pointer while the mouse pointer is over a control.
	property OnMouseUp;	Occurs when the user releases a mouse button that was pressed with the mouse pointer over a component.
	property OpenDialogButtonEnabled: Boolean read fOpenDialogButtonEnabled write SetOpenDialogButtonEnabled default true;	Enables or disables the button that brings up the file/folder picker dialog.
	property ParentColor;	Specifies where a control looks for its color information.
	property ParentDoubleBuffered;	ParentDoubleBuffered defers the DoubleBuffered property of this component to the value of the parent's DoubleBuffered property.
	property ParentFont read GetParentFont write SetParentFont;	Specifies where a control looks for its font information.
	property ParentShowHint;	Specifies where a control looks to find out if its Help Hint should be shown.
	property Path: UnicodeString read GetPath write SetPath;	Gives a string with a path or a folder name to TJamPathEdit
	property PopupMenu: TPopupMenu read GetPopupMenu write SetPopupMenu;	Specifies the pop-up menu associated with the control.
	property PopupMenuButton: TPopupMenu read GetPopupMenuButton write SetPopupMenuButton;	This is an add on to the normal inherited PopupMenu property.
	property ShowHint;	specifies whether to show the Help Hint when the mouse pointer moves over the control.
	property ShowImage: Boolean read fShowImage write SetShowImage default True;	If True (the default value), the system folder icon is shown on the button. If False, three dots (...) are shown on the button.
	property StyleName;	Specifies the style name for this control.
	property TabOrder;	Indicates the position of the control in its parent's tab order.
	property UseSystemFont: Boolean read fUseSystemFont write SetUseSystemFont default false;	Use the same Font as the Windows Explorer.
	property Version: String read GetVersion stored false;	The version number of the ShellBrower controls.
	property Visible;	Determines whether the component appears onscreen.

Links

JamControls, Legend, Members, Public Methods, TJamPathEdit Events, TJamPathEdit Methods, TJamPathEdit Properties

Contents | Index | Home