Text¶

Qualified name: delphifmx.Text

class Text¶

Bases: Control

TText defines 2D text objects. It inherits TControl and can be used in styles to construct controls. TText implements the ITextSettings interface. Therefore, TText objects provide all declared in ITextSettings methods and properties to manage the text appearance parameters declared in TTextSettings.

Methods

`AbsoluteToLocal`	Converts the screen coordinates of a specified point on the screen to client coordinates.
`AfterConstruction`	Responds after the last constructor has executed.
`BringToFront`	Puts the control in front of all other controls in its parent control.
`CanFocus`	Indicates whether a control can receive focus.
`LocalToAbsolute`	Translates a given point from client area coordinates to global screen coordinates.
`PrepareForPaint`	Prepares the current control for painting.
`Repaint`	Forces the control to repaint its image on the screen.
`ResetFocus`	Removes the focus from a control of from any children of the control.
`SendToBack`	Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.
`SetBounds`	Sets the Left, Top, Width, and Height properties all at once.
`SetFocus`	Gives the input focus to the control.

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.
`ActionClient`	Specifies whether the component object has an associated action.
`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.
`AutoSize`	Specifies whether TText control is auto-sized based on the length of the text.
`AxisAlignedRect`	A TRectF defined by the width and height of the control.
`BoundsRect`	Specifies the bounding rectangle of the control.
`CanParentFocus`	Specifies whether the parent of this control should be evaluated to receive focus.
`Canvas`	Provides the drawing surface of the control.
`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.
`Color`	Specifies the color of the Text.
`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
`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.
`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.
`FixedSize`	Embarcadero Technologies does not currently have any additional information.
`Font`	Specifies the attributes of text written on or in the 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).
`Hint`	Specifies the text string that appears when the user moves the mouse over a control.
`HitTest`	Enables the control to capture mouse events.
`HorzTextAlign`	Specifies how the text will be displayed in terms of horizontal alignment.
`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.
`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.
`Name`	Specifies the name of the component as referenced in code.
`Observers`	Indicates the TObservers object added to the TComponent.
`OnDragDrop`	Callable[[Object, DragObject, PointF], None]:
`OnDragEnter`	Callable[[Object, DragObject, PointF], None]:
`OnDragOver`	Callable[[Object, DragObject, PointF, DragOperation], None]:
`OnGesture`	Callable[[Object, GestureEventInfo, bool], None]:
`OnPaint`	Callable[[Object, Canvas, RectF], None]:
`OnPainting`	Callable[[Object, Canvas, RectF], 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
`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.
`PopupMenu`	Specifies the context (pop-up) menu object.
`Position`	Returns an access to the position of the control inside its parent
`PrefixStyle`	It determines the way to portray a single character, such as "&".
`Pressed`	Indicates whether the control is currently pressed.
`PressedPosition`	A point that indicates where exactly on the control the click occured.
`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.
`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.
`Stretch`	Specifies whether the text in the control will be displayed as stretched over the entire client area.
`StyleName`	Specifies the style name for this FMX component.
`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`	Specifies the text that will be displayed in the TText control.
`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.
`Trimming`	Specifies the behavior of the text, when it overflows the area for drawing the text.
`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`	Returns/Sets the Control Visibility
`Width`	Specifies the horizontal size of the control (in pixels).
`WordWrap`	Specifies whether the text inside the TText control wraps when it is longer than the width of the control.

AbsoluteToLocal()¶: Converts the screen coordinates of a specified point on the screen to client coordinates.

AfterConstruction()¶: Responds after the last constructor has executed. FMX.Objects.TText.AfterConstruction inherits from System.TObject.AfterConstruction. All content below this line refers to System.TObject.AfterConstruction. Responds after the last constructor has executed. AfterConstruction is called automatically after the object’s last constructor has executed. Do not call it explicitly in your applications. The AfterConstruction method implemented in TObject does nothing. Override this method when creating a class that performs an action after the object is created. For example, TCustomForm overrides AfterConstruction to generate an OnCreate event.

Align¶

Specifies the alignment options (top, left, client, and so on) of this control. Use Align to automatically set the alignment of the current control. Setting Align to a value different than None can affect the position, size (height and width), and anchors of the control. By default, Align is set to None. Descendants of TControl typically set the visibility and value for the Align property. For example, for TToolBar, Align defaults to TAlignLayout.Top. To see the possible values for Align and their visible effects over the control, see FMX.Types.TAlignLayout. 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:: AlignLayout

Anchors¶

Specifies how the control is anchored to its parent. Use Anchors to ensure that a control maintains its current position relative to the edges of its parent, even if the parent is resized. When its parent is resized, the control holds its position relative to the edges to which it is anchored. Anchors is enforced only when the parent control is resized. If a control is anchored to opposite edges at the same time, the control stretches horizontally or vertically to maintain constant the distance between the control edges and parent edges. If a control is anchored to all four edges of its parent, the control stretches in all directions. By default, a control is anchored to the top and left edges of its container (Anchors=[akTop,akLeft]). The automatic alignment may affect the anchors of a control. When Align is set to None, all the anchors are available. If Align is not None, the anchors affected by the automatic alignment are excluded. Changing the state of the anchors affected by the automatic alignment has no effect over the control. 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:: Anchors

AutoSize¶

Specifies whether TText control is auto-sized based on the length of the text. Set the AutoSize property to True to automatically resize the TText control according to the length of the Text. Set the AutoSize property to False to lock autoresize of the TText control.

Tip: The size of the TText control readjusts when the Font property changes. When both AutoSize and WordWrap are set to True, the height of the TText control increases to show the full text, while the width does not change. When AutoSize is set to True and WordWrap is False the width of the TText control changes to display the text in one line, while the height does not change.

Type:: bool

BringToFront()¶: Puts the control in front of all other controls in its parent control.

CanFocus()¶: Indicates whether a control can receive focus.

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

Color¶

Specifies the color of the Text. Use Color to set and get the color used to display Text within TText.

Type:: int

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. 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

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

Font¶

Specifies the attributes of text written on or in the control. To change to a new font, specify a new TFont object. To modify a font, change the value of the Family, Size, or Style of the TFont object.

Type:: Font

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

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

HorzTextAlign¶

Specifies how the text will be displayed in terms of horizontal alignment. The HorzTextAlign property specifies how the TText control will display the text in terms of horizontal alignment. HorzTextAlign can have one of the following values:

Center (default)–aligns the text on a horizontal axis, at the middle of the TText control. Leading–aligns the text on a horizontal axis, at the topmost position inside the TText control. Trailing–aligns the text on a horizontal axis, at the bottommost position inside the TText control.

Type:: TextAlign

IsFocused¶: Determines whether the control has input focus.

LocalToAbsolute()¶: Translates a given point from client area coordinates to global screen coordinates.

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:: Bounds

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]:

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:: Bounds

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

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:: CustomPopupMenu

Position¶: Returns an access to the position of the control inside its parent

PrefixStyle¶

It determines the way to portray a single character, such as “&”.

Type:: PrefixStyle

PrepareForPaint()¶: Prepares the current control for painting.

Repaint()¶: Forces the control to repaint its image on the screen.

ResetFocus()¶: Removes the focus from a control of from any children of the control.

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:: Position

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:: Position

SendToBack()¶: Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.

SetBounds(Left, Top, Width, Height)¶: Sets the Left, Top, Width, and Height properties all at once.

SetFocus()¶: Gives the input focus to the control.

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:: ControlSize

Stretch¶

Specifies whether the text in the control will be displayed as stretched over the entire client area. Set the Stretch property to True to display the text stretched over the entire client area of the TText control. Set the Stretch property to False to display the text normally, without the stretch effect. The default value for the Stretch property is False.

Tip: Setting the Stretch property to True cancels the effect of the WordWrap property.

Type:: bool

Text¶

Specifies the text that will be displayed in the TText control. The Text property sets or reads the text that is displayed by the TText control. Text is a string.

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

Trimming¶

Specifies the behavior of the text, when it overflows the area for drawing the text. Trimming may take the following values defined in the TTextTrimming type: None, Character, and Word. If the value of this property is not None and the text does not fit in the drawing area, then it is trimmed to fit the area and an ellipsis sign is printed after the trimmed text.

Note: For Android and iOS platforms, Trimming works only when WordWrap = False.

Type:: TextTrimming

VertTextAlign¶

Specifies how the text will be displayed in terms of vertical alignment. The VertTextAlign property specifies how the TText control will display the text in terms of vertical alignment. VertTextAlign can have one of the following values:

Center (default)–aligns the text on a vertical axis, at the middle of the TText control. Leading–aligns the text on a vertical axis, at the topmost position inside the TText control. Trailing–aligns the text on a vertical axis, at the bottommost position inside the TText control.

Type:: TextAlign

Visible¶: Returns/Sets the Control Visibility

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

WordWrap¶

Specifies whether the text inside the TText control wraps when it is longer than the width of the control. Set WordWrap to True to allow the TText control to display multiple lines of text. When WordWrap is True, text that is too long to fit in the TText control wraps at the right margin and continues in additional lines. Set WordWrap to False for the text to span onto a single line of the TText control. However, in this case, the text that is too long to fit in the TText control appears truncated.

Type:: bool