JamControls.TJamFilterCombo

The TJamFilterCombo represents a combobox for filter expressions.

Syntax

Pascal

TJamFilterCombo = class(TCustomComboBox, IJamShellControl);

Remarks

A typical use case is in custom open or save dialogs. Add the filters you want to supply via the FileTypeItems property.

Using a TJamShellLink the specified filter will be applied to components that can filter contents, like e.g. the TJamExplorerBrowser control.

Alternatively, you can set the Style property to csDropDown. In this case, users can type filters on the fly, that will be applied to linked components, when pressing Enter.

Namespace

JamControls

Public Methods

JamControls.TJamFilterCombo

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

TJamFilterCombo Classes

JamControls.TJamFilterCombo

	Name	Description
	TJamFileTypeItems = class(TFileTypeItems);	Helper class for synchronization of FileTypeItems and Items in the FilterCombo.

IJamShellControl Methods

	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.

JamControls.TJamFilterCombo

	Name	Description
	procedure FullRefresh;	Refreshes the contents of the control

IJamShellControl Properties

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

JamControls.TJamFilterCombo

	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 AutoCloseUp default False;	Specifies whether the drop-down closes up automatically when the user selects an item. See .
	property AutoComplete default True;	Positions to matching list items as you type. See .
	property AutoCompleteDelay default 500;	Specifies the delay between a key press and an attempt to autocomplete the field. See .
	property AutoDropDown default False;	Specifies whether the drop-down list drops down automatically in response to user keystrokes. See .
	property BevelEdges;	Specifies which edges of the control are beveled. See .
	property BevelInner;	Specifies the cut of the inner bevel. See .
	property BevelKind default bkNone;	Specifies the control's bevel style. See .
	property BevelOuter;	Specifies the cut of the outer bevel. See .
	property BiDiMode;	Specifies the bidirectional mode for the control. See .
	property CharCase;	Determines the case of the text in the combo box. See .
	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 CurrentFilter: string read GetCurrentFilter;	Returns the mask of the currently set Filter (i.e. without the displayname).
	property CurrentFilterItem: TFileTypeItem read GetCurrentFilterItem;	Returns the TFileTypeItem that is currently selected.
	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 Editable: boolean read GetEditable write SetEditable default false;	True, if only the values specified through FileTypeItems should be selectable as valid Filters; False, if the field is editable and custom expressions can be set on the fly.
	property Enabled;	Controls whether the control responds to mouse, keyboard, and timer events. See .
	property FileTypeItems: TJamFileTypeItems read FFileTypes write FFileTypes;	This property holds a list of TFileTypeItems. These Items consit of a displayname and a filemask that contains filter to limit the available files.
	property FilterString: string read GetFilterString write SetFilterString;	Gets or sets the filters that shall appear in the DropDown as '\|' seperated expression.
	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 ItemIndex default -;	Specifies the index of the selected item. See .
	property Items;	Items of Combobox that can be selected. The Items are sets of Filters that define what kind of recently used files should be suggested to the user
	property MaxLength;	Specifies the maximum number of characters the user can type into the edit portion of the combo box.
	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). See .
	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 OnDrawItem;	Occurs when an item in an owner-draw combo box needs to be displayed. See .
	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. See .
	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 OnMeasureItem;	Occurs when an item in a csOwnerDrawVariable combo box needs to be redisplayed. See .
	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. See .
	property OnStartDock;	Occurs when the user begins to drag a control with a DragKind of dkDock. See .
	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 ShellLink: TJamShellLink read getShellLink write setShellLink;	The TJamShellLink instance to which the current control connected.
	property ShowHint;	Specifies whether to show the Help Hint when the mouse pointer moves over the control.
	property Style default csDropDownList;	Determines the display style of the combo box. See .
	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 TextHint;	Specifies the text that is displayed as a text watermark in the edit box of the combo box control. See .
	property Touch;	Specifies the touch manager component associated with the control. See .
	property Visible;	Specifies whether the component appears onscreen.

Links

JamControls, Legend, Members, Public Methods, TJamFilterCombo Classes, IJamShellControl Methods, IJamShellControl Properties

Contents | Index | Home