SearchBox

Qualified name: delphifmx.SearchBox

class SearchBox

Bases: Edit

A search edit control. TSearchBox is an edit control that provides search capabilities such as filtering the result in the parent.

Methods

ApplyStyleLookup	Gets and applies the style of a TStyledControl.
Inflate	Call this procedure to get and apply its style lookup.
NeedStyleLookup	Call this procedure to indicate that this control requires to get and apply its style lookup.

Attributes

AbsoluteClipRect	Specifies the absolute rectangle of the control after all its parent controls clip it.
AbsoluteEnabled	Specifies whether the control is absolutely enabled.
AbsoluteHeight	Specifies the absolute height of the control.
AbsoluteMatrix	Specifies the absolute transformation matrix of the control.
AbsoluteOpacity	Specifies the absolute opacity of the control.
AbsoluteRect	Specifies the absolute rectangle that bounds the control.
AbsoluteScale	Specifies the absolute scale of the control.
AbsoluteWidth	Specifies the absolute width of the control.
Action	Specifies the action associated with the control.
ActionClient	Specifies whether the component object has an associated action.
AdjustSizeValue	Updates the width and height of this control according to its current style
AdjustType	Determines if and how the width and height of this control should be modified to take the fixed space dictated by the style of this control
Align	Specifies the alignment options (top, left, client, and so on) of this control.
Anchors	Specifies how the control is anchored to its parent.
ApplyingEffect	A flag that signals when a control is in the process of applying an effect.
AutoCapture	Specifies whether the control captures mouse events.
AutoSelect	bool:
AutoTranslate	Specifies whether the control's text should be translated
AxisAlignedRect	A TRectF defined by the width and height of the control.
BoundsRect	Specifies the bounding rectangle of the control.
ButtonsContent	Returns the control that contains the edit buttons associated with the edit control.
CanFocus	Specifies whether the current control can receive focus.
CanParentFocus	Specifies whether the parent of this control should be evaluated to receive focus.
Canvas	Provides the drawing surface of the control.
Caret	Represents the caret of the control.
CaretPosition	Provides access to the caret position in this edit control.
CharCase	It defines whether to implement the UPPER or lower case conversion to the memo's text.
CheckSpelling	Defines whether the spell-checking feature of the edit control is on or off.
Children	Stores an array of children attached to this parent component.
ChildrenCount	Read-only property that specifies the number of children in the children list.
ChildrenRect	Specifies the bigger rectangle area occupied by parent and children controls.
ClassName	Returns the TObject.ClassName
ClipChildren	Specifies if children of the control should be clipped to the control's on-screen region.
ClipParent	Specifies whether the current control has clipped its parent.
ClipRect	Specifies the bound rectangle to be clipped.
ComObject	Specifies the interface reference implemented by the component.
ComponentCount	Returns the owned component count
ComponentIndex	Indicates the position of the component in its owner's Components property array.
ComponentState	Describes the current state of the component, indicating when a component needs to avoid certain actions.
ComponentStyle	Governs the behavior of the component.
Components	Returns an iterator over the owned components
ControlType	ControlType:
Controls	Returns an iterator over contained controls
ControlsCount	Returns the count of contained controls
Cursor	Image to use to represent the mouse pointer when it passes into the region covered by the control.
Data	Stores a Tvalue, which is a data structure that can store different kinds of data types.
DefaultSize	Embarcadero Technologies does not currently have any additional information.
DefaultStyleLookupName	Returns a string with the name of the default style of this control
DefaultTextSettings	Stores a TTextSettings type object keeping the default values of the text representation properties.
DesignInfo	Contains information used by the Form designer.
DisableDisappear	Embarcadero Technologies does not currently have any additional information.
DisableFocusEffect	Specifies whether the control has the focus effect disabled.
DragMode	Specifies how the control initiates drag-and-drop operations.
EnableDragHighlight	Specifies whether the control is highlighted when the dragged object is over it.
Enabled	Specifies whether the control responds to mouse, keyboard, and timer events.
FilterChar	Defines characters which can be input in the edit field.
FixedSize	Embarcadero Technologies does not currently have any additional information.
Font	Specifies the font to use when rendering the text.
FontColor	Specifies the color of the text in the edit control.
HasAfterPaintEffect	Specifies whether the control has an effect that is applied after the control is painted.
HasClipParent	Control that is a direct child of this control and has clipped this control.
HasDisablePaintEffect	Specifies whether the control's effect is painted.
HasEffect	Specifies whether the control has an applied effect.
Height	Height specifies the vertical size of the control (in dp).
HelpContext	Contains the numeric context ID that identifies the Help topic for the control.
HelpKeyword	Contains the keyword string that identifies the Help topic for the control.
HelpType	Specifies whether the control's context-sensitive Help topic is identified by a context ID or by keyword.
HideSelectionOnExit	bool:
Hint	Specifies the text string that appears when the user moves the mouse over a control.
HitTest	Enables the control to capture mouse events.
ImeMode	For internal use only.
InPaintTo	Specifies whether the control is currently being painted.
Index	Specifies the index of the child object in the children array attached to this object.
InheritedCursor	Image used to represent the mouse pointer when it passes into the region covered by the control.
InvertAbsoluteMatrix	Specifies the inverse matrix of AbsoluteMatrix.
IsDragOver	Specifies whether a dragged object is over the area of the current control.
IsFocused	Determines whether the control has input focus.
IsInflated	Whether the current style of this control has been actually applied to the control.
IsMouseOver	Specifies whether the mouse cursor is over the control.
IsVisible	Specifies whether the control is visible.
KeyboardType	Determines the type of the virtual keyboard.
KillFocusByReturn	Specifies whether to hide the virtual keyboard by clicking the Return key.
LocalRect	Specifies the local rectangle for painting the control.
Locked	Specifies whether the control is locked at design time.
Margins	Aligns the component to the margins points of other components.
MaxLength	Maxmimum length of text that can be input in the edit field.
Model	The data model representing the data used by the presentation of the current control.
Name	Specifies the name of the component as referenced in code.
Observers	Indicates the TObservers object added to the TComponent.
OnCanFocus	Callable[[Object, bool], None]:
OnDragDrop	Callable[[Object, DragObject, PointF], None]:
OnDragEnter	Callable[[Object, DragObject, PointF], None]:
OnDragOver	Callable[[Object, DragObject, PointF, DragOperation], None]:
OnFilter	Callable[[Object, str, str, bool], None]:
OnGesture	Callable[[Object, GestureEventInfo, bool], None]:
OnPaint	Callable[[Object, Canvas, RectF], None]:
OnPainting	Callable[[Object, Canvas, RectF], None]:
OnPresentationNameChoosing	Callable[[Object, str], None]:
OnValidate	Callable[[Object, str], None]:
OnValidating	Callable[[Object, str], None]:
Opacity	Specifies the control opacity.
Owner	Returns the Component Owner
Padding	Aligns the component to the padding points of other components.
Parent	Returns/Sets the Control Visibility
ParentClassStyleLookupName	The name of the default style of the parent class of this control.
ParentControl	Specifies the parent control of this control.
ParentShowHint	If True, the value of the ShowHint property of this control inherits the value of the ShowHint property of the parent control.
ParentedRect	Specifies the bounding rectangle of the control within its parent.
ParentedVisible	Specifies whether all the control's parents are visible.
Password	Specifies whether this edit control shows its characters or not.
PopupMenu	Specifies the context (pop-up) menu object.
Position	Aligns the component to the position points of other components (Bounds points).
Presentation	Object:
PresentationProxy	PresentationProxy:
PresentationState	PresentationState:
Pressed	Indicates whether the control is currently pressed.
PressedPosition	A point that indicates where exactly on the control the click occured.
ReadOnly	Determines whether you can change the text of this edit control.
ResultingTextSettings	Keeps final values of text representation properties.
ReturnKeyType	Indicates the type of action that the edit control performs when you are editing the text of the control and you press the return key on the virtual keyboard.
Root	Specifies the root parent of this object.
RotationAngle	Specifies the amount (in degrees) by which the control is rotated from the x-axis.
RotationCenter	Specifies the position of the pivot point of the control.
Scale	Specifies the scale of the control.
Scene	Specifies the current scene in which the control is drawn.
SelLength	Specifies the number of characters that are selected.
SelStart	Specifies the position of the first selected character in the text.
SelText	Specifies the selected portion of the edit control's text.
SelectionFill	Specifies the color and pattern used to fill the font of the selected text or to stroke the outline of it.
ShowHint	Specifies whether the Hint can be shown.
Size	Specifies the vertical and horizontal size (Size.Height and Size.Width) of the control (in pixels).
Stored	Specifies whether this object is stored in the .XFM file.
StyleLookup	Specifies the name of the resource object to which the current TStyledControl is linked
StyleName	Specifies the style name for this FMX component.
StyleState	This property allows you to define the current state of style
StyledSettings	Defines the set of styled text representation properties whose values are loaded from the current style and cannot be changed manually.
StylesData	Value:
TabOrder	Indicates the position of the control in its parent's tab order.
TabStop	Embarcadero Technologies does not currently have any additional information.
Tag	Stores a NativeInt integral value as a part of a component.
TagFloat	Custom property that stores any floating-point value.
TagObject	Custom property that stores any object value.
TagString	Custom property that stores any string value.
Text	Contains the text displayed by this edit control.
TextAlign	Specifies how the text will be displayed in terms of horizontal alignment.
TextContentRect	Embarcadero Technologies does not currently have any additional information.
TextPrompt	A hint or message to be displayed when the Text property is empty.
TextSettings	Keeps the values of styled text representation properties that are set in the Object Inspector or programmatically.
Touch	Specifies the touch manager component associated with the control.
TouchTargetExpansion	Set of optional pixel values you can specify to expand the touch target of a FireMonkey styled control.
Typing	Specifies whether the user is typing something in this edit control.
UpdateRect	Specifies the rectangle area of the control that needs to be updated.
VCLComObject	Represents information used internally by components that support COM.
VertTextAlign	Specifies how the text will be displayed in terms of vertical alignment.
Visible	Specifies whether the component appears onscreen.
Width	Specifies the horizontal size of the control (in pixels).

AdjustSizeValue

Updates the width and height of this control according to its current style

AdjustType

Determines if and how the width and height of this control should be modified to take the fixed space dictated by the style of this control

ApplyStyleLookup()

Gets and applies the style of a TStyledControl.

AutoTranslate

Specifies whether the control’s text should be translated

DefaultStyleLookupName

Returns a string with the name of the default style of this control

Inflate()

Call this procedure to get and apply its style lookup.

Model

The data model representing the data used by the presentation of the current control. FMX.SearchBox.TSearchBox.Model inherits from FMX.Controls.Presentation.TPresentedControl.Model. All content below this line refers to FMX.Controls.Presentation.TPresentedControl.Model. The data model representing the data used by the presentation of the current control. The constructor of your presented control creates a data model for your presented control. The class of the data model is the class that DefineModelClass returns.

See Also

FMX.Controls.Model.TDataModel FMX.Controls.Presentation.TPresentedControl.Presentation FMX.Controls.Presentation.TPresentedControl.Create FMX.Controls.Presentation.TPresentedControl.DefineModelClass

Type:

SearchBoxModel

NeedStyleLookup()

Call this procedure to indicate that this control requires to get and apply its style lookup.

OnFilter

Callable[[Object, str, str, bool], None]:

StyleLookup

Specifies the name of the resource object to which the current TStyledControl is linked

StyleState

This property allows you to define the current state of style