Edit¶
Qualified name: delphifmx.Edit
- class Edit¶
Bases:
CustomEdit
General-purpose FireMonkey edit box. TEdit extends the functionality of TCustomEdit by publishing a set of properties to the Object Inspector so you can customize the look and feel of this edit box. For using TEdit in a Metro application, see Creating Metropolis UI Edit Buttons with Embedded Glyphs. When not in focus, TEdit does not draw a selection rectangle even though the user has selected the text. You can verify whether the text is selected by using the SelText property.
Note: For a multiline edit control, use FMX.Memo.TMemo.
Methods
Gets and applies the style of a TStyledControl.
Call this procedure to get and apply its style lookup.
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.
Specifies the action associated with the control.
ActionClient
Specifies whether the component object has an associated action.
Updates the width and height of this control according to its current style
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.
bool:
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.
Specifies whether the current control can receive focus.
Specifies whether the parent of this control should be evaluated to receive focus.
Canvas
Provides the drawing surface of the control.
Represents the caret of the control.
CaretPosition
Provides access to the caret position in this edit control.
It defines whether to implement the UPPER or lower case conversion to the memo's text.
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
Specifies if children of the control should be clipped to the control's on-screen region.
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:
Controls
Returns an iterator over contained controls
ControlsCount
Returns the count of contained controls
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.
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.
Specifies whether the control has the focus effect disabled.
Specifies how the control initiates drag-and-drop operations.
Specifies whether the control is highlighted when the dragged object is over it.
Specifies whether the control responds to mouse, keyboard, and timer events.
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 specifies the vertical size of the control (in dp).
Contains the numeric context ID that identifies the Help topic for the control.
Contains the keyword string that identifies the Help topic for the control.
Specifies whether the control's context-sensitive Help topic is identified by a context ID or by keyword.
bool:
Specifies the text string that appears when the user moves the mouse over a control.
Enables the control to capture mouse events.
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.
Determines the type of the virtual keyboard.
Specifies whether to hide the virtual keyboard by clicking the Return key.
LocalRect
Specifies the local rectangle for painting the control.
Specifies whether the control is locked at design time.
Aligns the component to the margins points of other components.
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.
Callable[[Object, bool], None]:
Callable[[Object, DragObject, PointF], None]:
Callable[[Object, DragObject, PointF], None]:
Callable[[Object, DragObject, PointF, DragOperation], None]:
OnGesture
Callable[[Object, GestureEventInfo, bool], None]:
Callable[[Object, Canvas, RectF], None]:
Callable[[Object, Canvas, RectF], None]:
Callable[[Object, str], None]:
Callable[[Object, str], None]:
Callable[[Object, str], None]:
Specifies the control opacity.
Owner
Returns the Component Owner
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.
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.
Specifies whether this edit control shows its characters or not.
Specifies the context (pop-up) menu object.
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.
Determines whether you can change the text of this edit control.
ResultingTextSettings
Keeps final values of text representation properties.
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.
Specifies the amount (in degrees) by which the control is rotated from the x-axis.
Specifies the position of the pivot point of the control.
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.
Specifies whether the Hint can be shown.
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.
Specifies the name of the resource object to which the current TStyledControl is linked
StyleName
Specifies the style name for this FMX component.
This property allows you to define the current state of style
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.
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.
A hint or message to be displayed when the Text property is empty.
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.
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.
Specifies whether the component appears onscreen.
Specifies the horizontal size of the control (in pixels).
- Action¶
Specifies the action associated with the control. Action allows an application to centralize the response to user commands. When a control is associated with an action, the action determines the appropriate properties and events of the control (such as whether the control is enabled or how it responds to an OnClick event). If an object of the descendant from the TFmxObject class does not support actions, and when this object tries to assign a value to the Action property, the setter method for Action calls GetActionLinkClass that should return nil. In this case, attempting to set a value to the Action property raises the following exception:
StrEActionNoSuported = ‘Class %s does not support the action’
- Type:
- 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.
- AutoSelect¶
bool:
- AutoTranslate¶
Specifies whether the control’s text should be translated
- CanFocus¶
Specifies whether the current control can receive focus. CanFocus is True if it can receive focus, and False otherwise. If it is set to False, the control cannot be selected when using the TAB key. A control can receive focus after it is created.
- Type:
bool
- CanParentFocus¶
Specifies whether the parent of this control should be evaluated to receive focus. CanParentFocus is True when the parent of this control should be evaluated to receive focus if this control cannot receive focus itself, and False otherwise.
- Type:
bool
- Caret¶
Represents the caret of the control. Caret is of type TCaret.
- Type:
CustomCaret
- CharCase¶
It defines whether to implement the UPPER or lower case conversion to the memo’s text.
- Type:
EditCharCase
- CheckSpelling¶
Defines whether the spell-checking feature of the edit control is on or off. This property enables spell checking on the TEdit component. When set to True a red squiggly line appears underlining the words misspelled. The spell checking is performed by an operating system service. It is only supported on iOS and OS X.
- Type:
bool
- ClipChildren¶
Specifies if children of the control should be clipped to the control’s on-screen region. Set ClipChildren to
True if you want child controls to be clipped to the control’s on-screen region. False if you want child controls to be able to extend beyond the region of the parent control.
- Type:
bool
- ClipParent¶
Specifies whether the current control has clipped its parent. When ClipParent is True, TControl cuts off the portion of the parent that lies under the control when the control is painted by the Paint and Painting methods. Parts of the control that do not contain visible objects cut off holes in the parent’s image. ClipParent is ignored in PaintChildren and other painting methods. If one parent has more that one child control having ClipParent equals True, then only one of these child controls is painted with ClipParent equals True. Others child controls are painted as if ClipParent equals False.
- Type:
bool
- ControlType¶
ControlType:
- Cursor¶
Image to use to represent the mouse pointer when it passes into the region covered by the control. Change the value of Cursor to provide feedback to the user when the mouse pointer enters the control. For a list of cursor constants, see System.UITypes Constants. The image representations of the cursor depend on the theme active on the current platform. If Cursor is set to the default cursor, this control might display a different cursor when the mouse pointer is over it. The actual cursor that this control displays is the cursor defined in InheritedCursor, a read-only property that is calculated based not only in the value of Cursor in this control, but also the value of Cursor in any ancestor of this control (parent, grand-parent, and so on until the parent form).
- Type:
int
- DefaultStyleLookupName¶
Returns a string with the name of the default style of this control
- DisableFocusEffect¶
Specifies whether the control has the focus effect disabled. Set DisableFocusEffect to True so the control disables the effect applied when it receives focus. Usually, DisableFocusEffect for FireMonkey controls is False.
- Type:
bool
- DragMode¶
Specifies how the control initiates drag-and-drop operations. Use DragMode to control when the user can drag the control. Disable the drag-and-drop capability at run time by setting the DragMode property value to dmManual. Enable automatic dragging by setting DragMode to dmAutomatic.
- Type:
DragMode
- EnableDragHighlight¶
Specifies whether the control is highlighted when the dragged object is over it.
- Type:
bool
- Enabled¶
Specifies whether the control responds to mouse, keyboard, and timer events. Use Enabled to change the availability of the control to the user. To disable a control, set Enabled to False. Some disabled controls appear dimmed (for example: buttons, check boxes, labels), while others (container controls) simply lose their functionality without changing their appearance. If Enabled is set to False, the control ignores mouse, keyboard, and timer events. To re-enable a control, set Enabled to True. This property applies to all TControl descendants.
- Type:
bool
- FilterChar¶
Defines characters which can be input in the edit field. All characters not in FilterChar will be ignored. Empty FilterChar value means no filtering.
- Type:
str
- Height¶
Height specifies the vertical size of the control (in dp). Use the Height property to read or change the height of the control.
- Type:
float
- HelpContext¶
Contains the numeric context ID that identifies the Help topic for the control. In case of a .chm Help file, you must symbolically map Context IDs of Help topics to numeric topic ID values in the [MAP] section of your project (.hhp) file. To enable Context ID-based context-sensitive Help for a control, set HelpType to htContext and set HelpContext to a numeric topic ID. A topic ID of 0 (default) means that no Help topic is provided for the control.
- Type:
int
- HelpKeyword¶
Contains the keyword string that identifies the Help topic for the control. To enable the keyword-based context-sensitive Help for a control, set the HelpType property to htKeyword and set HelpKeyword to a keyword string. No keyword (zero-length string, the default) means that no Help topic is provided for the control.
- Type:
str
- HelpType¶
Specifies whether the control’s context-sensitive Help topic is identified by a context ID or by keyword. If HelpType is htContext, the HelpContext property value identifies the control’s Help topic. If HelpType is htKeyword, the HelpKeyword property value identifies the control’s Help topic.
- Type:
HelpType
- HideSelectionOnExit¶
bool:
- Hint¶
Specifies the text string that appears when the user moves the mouse over a control. See Using Hints to Show Contextual Help in a FireMonkey Application for more information about hints.
- Type:
str
- HitTest¶
Enables the control to capture mouse events.
If you set HitTest to True, this control captures all mouse events. The example below shows the use of HitTest for an OnClick event. If you set HitTest to False, the mouse events will pass through this control, so that a control laid out behind this one receives the mouse events instead of this control. Note: The HitTest enables all mouse-related events, which also include the display of Hints and Hint-related events. For most controls, HitTest is True by default. However, this is not true for all the controls. For example, for TLabel and TPathLabel, HitTest is False by default; these two controls do not capture the mouse-related events unless you set HitTest to True.
Example of HitTest 1. On a form, place a TPanel component. 2. Inside the panel, place a TPathLabel component. 3. Implement the OnClick event for both the TPanel and the TPathLabel:
procedure TForm1.Panel1Click(Sender: TObject); begin
ShowMessage(‘OnClick event fired for TPanel’);
end;
procedure TForm1.PathLabel1Click(Sender: TObject); begin
ShowMessage(‘OnClick event fired for TPathLabel’);
end;
Set the TPathLabel HitTest property to False (this is the default setting). Run the application and click the label. The OnClick event is fired for the panel (not the label).
Set the TPathLabel HitTest property to True. Run the application and click the label. The OnClick event is fired for the TPathLabel.
- Type:
bool
- ImeMode¶
For internal use only. Do not use this member. It is for internal use only.
- Type:
ImeMode
- Inflate()¶
Call this procedure to get and apply its style lookup.
- KeyboardType¶
Determines the type of the virtual keyboard. Set KeyboardType to determine the type of virtual keyboard this edit is to use. Possible values for the KeyboardType property are Alphabet, Default, EmailAddress, NamePhonePad, and so on (values are selectable in the Object Inspector and are described in FMX.Types.TVirtualKeyboardType). Keyboard types are illustrated in the Mobile Tutorial: Using the Web Browser Component (iOS and Android).
Note: On Android, the Alphabet keyboard type has no word completion or word suggestions. The keyboard looks the same as the Default keyboard, but without suggestions.
- Type:
VirtualKeyboardType
- KillFocusByReturn¶
Specifies whether to hide the virtual keyboard by clicking the Return key. When KillFocusByReturn is True, clicking the Return key hides the virtual keyboard.
- Type:
bool
- Locked¶
Specifies whether the control is locked at design time. A locked control prohibits to move the control at design time, all the other properties can be modified at design time. To lock the control, set Locked to True. By default, Locked is False, and the control can be modified at design time.
- Type:
bool
- Margins¶
Aligns the component to the margins points of other components. The Margins of a control are the distances (in pixels) from each edge (top, left, bottom, right) to another control within the same Parent or to the edge of its Parent. The Margins add space to the outer side of the control. It only applies for controls that do not use TAlignLayout None and the components are located to each other. If a margin is not 0, no other control will come closer to the control than the specified distance. If the distance from a Parent edge to the corresponding control edge is smaller than the specified Margins for that edge, the control is repositioned and resized, if necessary, to maintain the specified distance. If the Margins control has zero values, RAD Studio uses the default values (Left=4, Top=4, Right=4, Bottom=4). You can also set your own Margins values. It only applies to the IDE control’s guidelines, when you are dragging control. But if you use Align=Client (for example), it will use the specified values in Margins. The following image shows how Padding and Margins properties affect alignment, position, and size of controls.
- Type:
- MaxLength¶
Maxmimum length of text that can be input in the edit field.
- Type:
int
- NeedStyleLookup()¶
Call this procedure to indicate that this control requires to get and apply its style lookup.
- OnCanFocus¶
Callable[[Object, bool], None]:
- OnDragDrop¶
Callable[[Object, DragObject, PointF], None]:
- OnDragEnter¶
Callable[[Object, DragObject, PointF], None]:
- OnDragOver¶
Callable[[Object, DragObject, PointF, DragOperation], 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. Set Opacity to customize the transparency of the current control. Opacity takes values between 0 and 1. If Opacity is 1, the control is completely opaque; if it is 0, the control is completely transparent. The values over 1 are treated as 1, and the ones under 0 are treated as 0. Opacity applies to the control’s children.
- Type:
float
- Padding¶
Aligns the component to the padding points of other components. The Padding of a control specifies how close, in pixels, the control’s children can come to each of its edges (top, left, bottom, right). Padding adds space to the inner side of the control. The control’s children are repositioned and resized, if necessary, to maintain the Padding. If the Padding control has zero values, RAD Studio uses the default values (Left=4, Top=4, Right=4, Bottom=4). You can also set your own Padding values. The following image shows how Padding and Margins properties affect alignment, position, and size of controls.
Note: Padding constraints do not work for TScrollBox, TListBox, TTreeView, and TGrid based controls.
- Type:
- ParentShowHint¶
If True, the value of the ShowHint property of this control inherits the value of the ShowHint property of the parent control. See Using Hints to Show Contextual Help in a FireMonkey Application - Enabling Hints for a Control for more information.
- Type:
bool
- Password¶
Specifies whether this edit control shows its characters or not. Set the Password property to True to make this edit control hide its characters for password-like input. Set Password to False to make this edit control show all its characters.
- Type:
bool
- PopupMenu¶
Specifies the context (pop-up) menu object. Use PopupMenu to set the context menu of the current control. The pop-up window is displayed when ShowContextMenu is called.
- Type:
- Position¶
Aligns the component to the position points of other components (Bounds points). Specifies the upper-left corner of the current control, relative to its parent. The Position can be affected by the Padding of its parent and the Margins of the control.
- Type:
- ReadOnly¶
Determines whether you can change the text of this edit control. To prevent the contents of the edit control from being edited, set the ReadOnly property to True. Set ReadOnly to False to allow the contents of the edit control to be edited. Setting ReadOnly to True ensures that the text is not altered, while still allowing you to select text. The selected text can then be manipulated by the application, or copied to the Clipboard.
- Type:
bool
- 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. The run-time platform uses this value to determine the type of return button that it displays on the virtual keyboard for the edit control. The value of ReturnKeyType does not affect the actual action that the edit control performs when you press the return key. To define that action, use the OnKeyUp event.
Platform Support This property only has effect on Android and iOS.
- Type:
ReturnKeyType
- RotationAngle¶
Specifies the amount (in degrees) by which the control is rotated from the x-axis. Positive angles correspond to clockwise rotation. For counterclockwise rotation, use negative values. To set the rotation center, use RotationCenter.
- Type:
float
- RotationCenter¶
Specifies the position of the pivot point of the control. The coordinates of the rotation center take values in the range from 0 through 1. The point with the coordinates (0,0) corresponds to the upper-left corner of the control, the point with the coordinates (1,1) corresponds to the lower-right corner of the control. The default center of rotation is (0.5, 0.5). Values outside of [0,0] and [1,1] can be clipped in some descendant classes. To set the rotation angle, use RotationAngle.
- Type:
- Scale¶
Specifies the scale of the control. Set the Scale coordinates to specify the scale on each axis. The initial scale rate is 1 on each axis.
Note: Controls that have the Align or Anchors properties set can use a scale that is different from the default (1,1), so that controls align together even when they have a custom scale.
- Type:
- ShowHint¶
Specifies whether the Hint can be shown. If ShowHint is set to True, a Hint string is displayed when the user moves the mouse over the control.
- Type:
bool
- Size¶
Specifies the vertical and horizontal size (Size.Height and Size.Width) of the control (in pixels). Use the Size property to read or change the size of the control.
- Type:
- 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
- StyledSettings¶
Defines the set of styled text representation properties whose values are loaded from the current style and cannot be changed manually. Text representation properties are used as parameters for drawing texts in controls. The StyledSettings property is used in FMX controls such as TButton, TSpeedButton, TCheckBox, and others. Styles, for example Metropolis UI styles, define the default values of the text representation properties like font name, font size, word-wrapping, and others. The TTextSettings class define properties keeping values of the FontColor, TextAlign, VertTextAlign, Trimming, WordWrap, and Font (TFont.Family, TFont.Size, TFont.Style) elements defining visual parameters of a text representation. StyledSettings can contain the Family, Size, Style, FontColor, and Other values defined in TStyledSetting. The “Relation between TStyledSetting constants and TTextSettings properties” table shows which of the TStyledSetting constants control the handling of these TTextSettings text representation properties. Keep in mind that the values of all styled text representation properties listed in the StyledSettings are taken from a style and cannot be changed manually. For example, if you set a new value of the FontColor property of a TTextControl control, then the real updating of the font color takes place only if the StyledSettings property of this control does not contain TStyledSetting.FontColor. For more details, see the example in Setting Text Parameters in FireMonkey. To switch OFF a font property for a control, select the control in the Form Designer. In the Object Inspector, expand the StyledSettings property. Clear the check mark before the property. For example, the following figure shows a TButton control with Size turned OFF (for Button1) and ON (for Button2):
With StyledSettings you can also use the DefaultStyledSettings constant that defines the values of the styled properties that are taken from a style by default. Remember that the HorzAlign and VertAlign text representation properties stored in the TextSettings property of a control correspond to the TextAlign and VertTextAlign properties of the control.
- Type:
StyledSettings
- Text¶
Contains the text displayed by this edit control. Use the Text property to read the text of this edit control or to specify a new string to be displayed.
- Type:
str
- TextPrompt¶
A hint or message to be displayed when the Text property is empty. Use TextPrompt to cue the user about the kind of entry that is expected in the text field. The TextPrompt is grayed (like a watermark), cannot be scrolled at run time, and is cleared from the entry field as soon as the user begins to type into the edit field. The following image contains a design-time preview of setting the TextPrompt property:
- Type:
str
- TextSettings¶
Keeps the values of styled text representation properties that are set in the Object Inspector or programmatically. TextSettings references a TTextSettings type object that handles values of styled text representation properties that are set in the Object Inspector or programmatically. TextSettings references a TTextSettings type object, which handles styled text representation properties to be used for drawing texts in this control. TTextSettings type objects provide all styled text representation properties and methods to manage them. The styled text representation properties are FontColor, TextAlign, VertTextAlign, Trimming, WordWrap, and Font (TFont.Family, TFont.Size, and TFont.Style). TTextSettings objects provide both styled text representation properties, whose values are loaded from a style (specified in StyledSettings), so all other styled text representation properties, whose values can be set manually, and methods to manage these text representation properties. The text representation properties identified in StyledSettings are loaded from the style and cannot be set manually. Remember that the HorzAlign and VertAlign text representation properties stored in the TextSettings property of a control correspond to the TextAlign and VertTextAlign properties of the control.
- Type:
TextSettings
- TouchTargetExpansion¶
Set of optional pixel values you can specify to expand the touch target of a FireMonkey styled control. FMX.Controls.TControl.TouchTargetExpansion is a published property of all FireMonkey styled controls that support Touch. Defined as an FMX.Types.TBounds, TouchTargetExpansion takes four optional parameters representing the expansion of the four sides of the control in pixels (Bottom, Left, Right, Top). Each parameter specifies the size of an additional screen area that is to be treated as part of the touch target of the control. The following figure illustrates how TouchTargetExpansion expands the touch target for a FireMonkey control:
- Type:
- Visible¶
Specifies whether the component appears onscreen. Use the Visible property to control the visibility of the control at run time. If Visible is True, the control appears. If Visible is False, the control is not visible.
- Type:
bool
- Width¶
Specifies the horizontal size of the control (in pixels). Use the Width property to read or change the width of the control.
- Type:
float