JamControls.TJamOpenSaveComboBox

TJamOpenSaveComboBox is a ComboBox filled with the recently used files that are loaded from the registry.

Syntax

Pascal

TJamOpenSaveComboBox = class(TJamCustomFolderCombo, IJamShellControl, IJamSupportsFilter);

Remarks

The control represents the edit component known from FileOpen or Save dialogs and can be used in those use cases.

It can easily be linked with other components such as an ExplorerBrowser and a TJamFilterCombo to make up a custom opening dialog. The path that was selected by the user can be retrieved using the SelectedPath property. Note, that this file need not actually exist in the file-system (as is needed for save dialogs).

Namespace

JamControls

Public Methods

	Name	Description
	constructor Create(AOwner: TComponent); override;	Creates an instance of a TJamCustomEditComboBox component.
	destructor Destroy; override;	Deletes an instance of a TJamCustomEditComboBox component.

JamControls.TJamCustomFolderCombo

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

JamControls.TJamOpenSaveComboBox

	Name	Description
	constructor Create(AOwner: TComponent); override;	Creates an instance of this class.
	destructor Destroy; override;	Destructor of this class.

TJamCustomEditComboBox Methods

	Name	Description
	procedure SelectAll; override;	Selects the entire block of text in the edit box.
	procedure Undo;	Undoes the last edit control operation.

JamControls.TJamCustomFolderCombo

	Name	Description
	procedure Add(const pItemIdList: IItemIdList);	Adds the given ITemIdList to the dropdown list.
	procedure Clear; override;	Deletes all text from the edit box and all items from the Items list.
	procedure Delete(Index: Integer);	Deletes the item with the given index from the Items list.
	function IndexOfPath(const pFullPath: string): Integer;	Returns the index of the given path.
	function InsertItem(pIndex: Integer; pIndent: Integer; const pItemIdList: IItemIdList; pIconNumber: Integer = -1; const pCaption: UnicodeString = ''): Integer; overload;	Adds an item to this control.
	function IsClosingUp: Boolean;	Returns True if the drop down list is about to close up or was just closing up; False otherwise.
	procedure KeyPress(var Key: Char); override;	KeyPress processes standard keystroke messages for the combo box control.

ShellLink.IJamShellControl

	Name	Description
	procedure FileChanged(FolderPIDL: IItemIdList; FilePIDL: IItemIdList);	This method is called by the ShellLink instance if the currently selected item has changed.
	function getShellLink: TJamShellLink;	Getter method for the ShellLink property.
	function GoUp: Boolean;	This method indicates that the callee should go up one level and display the contents of the current folder's parent folder.
	procedure PathChanged(FolderPIDL: IItemIdList);	This method is called by the ShellLink instance if the currently displayed folder has changed.
	procedure Refresh(pRefreshLevel: TRefreshLevel; pItemIdList: IItemIdList = nil);	This method indicates that the control should perform a refresh of its contents.
	procedure SelectAll;	This method indicates that the callee should select all item it currently displays.
	procedure setShellLink(aValue: TJamShellLink);	Setter method for the ShellLink property.

ShellLink.IJamSupportsFilter

	Name	Description
	procedure FilterChanged(const Filter: string);	Called by the ShellLink instance when the Filter is changed.

JamControls.TJamOpenSaveComboBox

	Name	Description
	procedure FullRefresh;	Refreshes the contents of the control and fills the dropdownlist with Files. The procedure compares the Files, delivered by the FillFileList function, with the defined Filters and choses those that match with a Filter.

TJamCustomEditComboBox Properties

	Name	Description
	property Cancelled: Boolean read fCancelled;	returns true if the user pressed the ESC key when the list was dropped down or the list was closed without selecting an item, false otherwise. Can be useful in the OnCloseUp Event.
	property CloseupScrollable: Boolean read fCloseupScrollable write fCloseupScrollable default True;	Determines if items can be scrolled when drop-down list is closed up.
	property EditText: string read GetEditText write SetEditText;	The Text in the Edit field.
	property OnCloseUp;	Occurs when the drop-down list closes up due to some user action.
	property ParentFont read GetParentFont write SetParentFont default False;	Specifies where a control looks for its font information.
	property UseSystemFont: Boolean read GetUseSystemFont write SetUseSystemFont default True;	Set this property to true if you want the component to utilize the default system font.
	property Version: String read GetVersion stored false;	The version number of the ShellBrower controls.

JamControls.TJamCustomFolderCombo

	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 AutoCompleteOptions default [acoAutoSuggest,acoAutoAppend];	Specifies options that control autocompletion.
	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;	Specifies the cut of the outer bevel.
	property BiDiMode;	Specifies the bidirectional mode for the control. See .
	property CloseupScrollable;	Determines if items can be scrolled when drop-down list is closed up.
	property Color;	Specifies the background color of the control.
	property Constraints;	Use Constraints to specify the minimum and maximum width and height of the control.
	property Ctl3D;	Determines whether a control has a three-dimensional (3-D) or two-dimensional look.
	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 how the control initiates drag-and-drop or drag-and-dock operations.
	property DropDownCount;	Specifies the maximum number of items displayed in the drop-down list.
	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 ImeMode;	Determines the behavior of the input method editor (IME).
	property ImeName;	Specifies the input method editor (IME) to use for converting keyboard input to Asian language characters.
	property ItemHeight;	Specifies the height, in pixels, of the items in the drop-down list.
	property MaxLength;	Specifies the maximum number of characters the user can type into the edit portion of the combo box.
	property Objects [Index: Integer]: TJamComboItem read GetJamComboItem;	Provides access to the list of TJamComboItems.
	property OnCanResize;	Occurs when an attempt is made to resize the control.
	property OnChange;	Occurs when the user changes the text displayed in the edit region.
	property OnClick;	Occurs when the user clicks the control.
	property OnCloseUp;	Occurs when the drop-down list closes up due to some user action.
	property OnContextPopup;	Occurs when the user right-clicks the control or otherwise invokes the pop-up menu (such as using the keyboard).
	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 OnDropDown;	Occurs when the user opens the drop-down list.
	property OnEndDock;	Occurs when the dragging of an object ends, either by docking the object or by canceling the dragging.
	property OnEndDrag;	Occurs when the dragging of an object ends, either by dropping the object or by canceling the dragging.
	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 OnGesture;	Occurs when you perform a gesture associated with this control. See .
	property OnKeyDown;	Occurs when a user presses any key while the control has focus.
	property OnKeyPress;	Occurs when key pressed.
	property OnKeyUp;	Occurs when the user releases a key that was pressed.
	property OnMouseEnter;	Occurs when the user moves the mouse into a control. See .
	property OnMouseLeave;	Occurs when the user moves the mouse outside of a control. See .
	property OnSelect;	Occurs when the user selects a string in the drop-down list.
	property OnStartDock;	Occurs when the user begins to drag a control with a DragKind of dkDock.
	property OnStartDrag;	Occurs when the user begins to drag the control or an object it contains by left-clicking the control and holding the mouse button down.
	property ParentBiDiMode;	Specifies whether the control uses its parent's BiDiMode. See .
	property ParentColor;	Specifies where a control looks for its color information.
	property ParentCtl3D;	Determines where a component looks to determine whether it should have a three-dimensional look.
	property ParentDoubleBuffered;	ParentDoubleBuffered defers the DoubleBuffered property of this component to the value of the parent's DoubleBuffered property.
	property ParentFont;	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 PopupMenu;	Specifies the pop-up menu associated with the control.
	property ShowHint;	Specifies whether to show the Help Hint when the mouse pointer moves over the control.
	property StyleElements;	Specifies the style elements that are used by the control. See .
	property StyleName;	Specifies the style name for this control.
	property TabOrder;	Indicates the position of the control in its parent's tab order.
	property TabStop;	Determines whether the user can tab to a control.
	property Text;	Specifies the text string that is displayed in the edit box.
	property Touch;	Specifies the touch manager component associated with the control. See .
	property Visible;	Specifies whether the component appears onscreen.

ShellLink.IJamShellControl

	Name	Description
	property ShellLink: TJamShellLink read getShellLink write setShellLink;	The TJamShellLink instance to which the current control connected.

JamControls.TJamOpenSaveComboBox

	Name	Description
	property DisplayImages: Boolean read fDisplayImages write fDisplayImages default false;	Set to true, if file icons should be added to the list.
	property DropDownCount default 14;	Specifies the maximum number of items displayed in the drop-down list.
	property Enabled;	Controls whether the control responds to mouse, keyboard, and timer events. See .
	property FileNameFormat: TJamFileNameFormat read fFileNameFormat write fFileNameFormat default TJamFileNameFormat;	Specifies if the text in the component contains a FileExtension, or not, or if this according to Windows Explorer settings.
	property Filter: String read GetFilter write SetFilter;	Gets or sets the current filter. If set, only matching elements from the receently used files will be available in the drop-down.
	property ItemIndex default -;	Specifies the index of the selected item. See .
	property OnPathSelected: TNotifyEvent read fOnPathSelected write fOnPathSelected;	Occurs, when the user presses Enter on a potentially valid path.
	property SelectedPath;	The currently selected path in the control.
	property ShellLink: TJamShellLink read getShellLink write setShellLink;	The TJamShellLink instance to which the current control connected.
	property Style;	Determines the display style of the combo box. See .

Links

JamControls, Legend, Members, Public Methods, TJamCustomEditComboBox Methods, TJamCustomEditComboBox Properties

Contents | Index | Home