Jam.Shell.Controls.SearchEdit.TJamSearchEdit

A TJamSearchEdit is an edit field with an optional button on the right side.

The icons are created from a font symbol (using Segoe UI Symbol if available, else WingDings).

The action executed with the button has to be implemented in the TJamSearchEdit.OnInvokeSearch event. Using TJamSearchEdit.QuickSearch the action will be called automatically while typing after a short delay.

Class Hierarchy

Syntax

Pascal

TJamSearchEdit = class(TCustomButtonedEdit);

Namespace

Jam.Shell.Controls.SearchEdit

Public Methods

	Name	Description
	constructor Create(pOwner: TComponent); override;	Constructor for creating a TJamSearchEdit instance.
	destructor Destroy; override;	Destructor for destroying a TJamShellSearchEdit instance.

TJamSearchEdit Events

	Name	Description
	property OnGetButtonIcon: TOnPaintButtonEvent read fGetButtonIcon write fGetButtonIcon;	Event is called for each icon that this control supports. Use it to set preferences on button icons.
	property OnInvokeSearch: TOnInvokeSearch read fOnInvokeSearch write fOnInvokeSearch;	Called, when the search is triggered, either using the button or via the timer.

TJamSearchEdit Methods

	Name	Description
	procedure Clear; override;	Clears the search query.
	procedure Repaint; override;	Repaints the control.

TJamSearchEdit 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 AutoSelect;	Determines whether all the text in the edit control is automatically selected when the control gets focus.
	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 default bkNone;	Specifies the control's bevel style.
	property BevelOuter;	Specifies the cut of the outer bevel.
	property BevelWidth;	Specifies the width of the inner and outer bevels.
	property BiDiMode;	See TControl.BiDiMode
	property BorderStyle;	Determines whether the edit control has a single line border around the client area.
	property CharCase;	Determines the case of the text within the edit control.
	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 Enabled;	Controls whether the control responds to mouse, keyboard, and timer events.
	property Font;	Specifies the attributes of text written on or in the control.
	property GetButtonClearSymbolFunction: TFunc<WideChar> read fGetButtonClearSymbolFuntion write fGetButtonClearSymbolFuntion;	Set an implementation for the char to be used as the clear button icon. The character refers to Segoe MDL2 Assets on Windows 11, and Segoe UI Symbol in prior Windows versions.
	property GetButtonSymbolFunction: TFunc<WideChar> read fGetButtonSymbolFunction write fGetButtonSymbolFunction;	Set an implementation for the char to be used as main button icon. The character refers to Segoe MDL2 Assets on Windows 11, and Segoe UI Symbol in prior Windows versions.
	property HideSelection;	Determines whether the visual indication of the selected text remains when focus shifts to another control.
	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 OnClick;	Occurs when the user clicks the control.
	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 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.
	property OnKeyDown;	Occurs when a user presses any key while the control has focus.
	property OnKeyPress;	Occurs when a key is pressed.
	property OnKeyUp;	Occurs when the user releases a key that was pressed.
	property OnMouseActivate;	Occurs when the user presses a mouse button with the mouse pointer over a control and the parent form is not active.
	property OnMouseDown;	Occurs when the user presses a mouse button with the mouse pointer over a control.
	property OnMouseEnter;	Occurs when the mouse pointer moves over the control.
	property OnMouseLeave;	Occurs when the mouse pointer moves off from over the 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 OnReset: TNotifyEvent read fOnReset write fOnReset;	Called, when the user presses the button to reset the search field.
	property OnResize;	Occurs when the control is resized.
	property ParentColor;	Determines where a control looks for its color information.
	property ParentFont;	Specifies where a control looks for its font information.
	property PopupMenu;	Specifies the pop-up menu associated with the control.
	property QuickSearch: Boolean read fQuickSearch write fQuickSearch default True;	Gets or sets the usage of the quick search mode.
	property QuickSearchDelay: Cardinal read fQuickSearchDelay write fQuickSearchDelay default 250;	Amount of time in milliseconds to delay the search in the quick search mode. After this delay has expired the search is started.
	property ReadOnly;	Determines whether the user can change the text of the edit control.
	property ShowButton: boolean read GetShowButton write SetShowButton default true;	Determines whether the magnifying icon is displayed in the control.
	property StyleElements;	Specifies the style elements that are used by the control.
	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 Touch;	Specifies the touch manager component associated with the control.
	property Visible;	Determines whether the component appears on screen.

Links

Jam.Shell.Controls.SearchEdit, Legend, Members, Public Methods, TJamSearchEdit Events, TJamSearchEdit Methods, TJamSearchEdit Properties

Contents | Index | Home