ListBoxItem#

Qualified name: delphifmx.ListBoxItem

class ListBoxItem#

Bases: TextControl

A TListBoxItem is an item that is used in list box components. The items in list boxes and combo boxes are of type TListBoxItem. To add an item to a list box or combo box, double-click the component or right-click the component and choose Add Item.

Methods

ApplyStyleLookup

Gets and applies the style of a TStyledControl.

ApplyTriggerEffect

Applies the specified mouse trigger effect to all the children of this FMX object that are of type TEffect.

Create

Allocates memory and constructs a safely initialized instance of a component.

Destroy

Disposes of the component and its owned components.

GetParentComponent

Returns the containing component.

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.

SetIsSelectedInternal

Processes the selection of an item.

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.

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.

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.

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.

ComObject

Specifies the interface reference implemented by the component.

ComponentCount

Indicates the number of components owned by the component.

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

<Delphi indexed property Components of type TComponent at 1619D745CD0>

Controls

Stores an array of child controls attached to this parent control.

ControlsCount

Number of controls that are direct children of this control.

Cursor

Image to use to represent the mouse pointer when it passes into the region covered by the control.

CustomSceneAddRect

<Delphi property CustomSceneAddRect of type TControl at 1619D6A6160>

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.

FixedSize

Embarcadero Technologies does not currently have any additional information.

Font

Specifies the font to use when rendering the text.

FontColor

Specifies the font color of the text in this TTextControl 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.

Hint

Specifies the text string that appears when the user moves the mouse over a control.

HitTest

Enables the control to capture mouse events.

ImageIndex

Defines the zero-based index enumerating images in the Images list of images.

Images

Defines the reference to a TCustomImageList list of images to be used to draw images on the component.

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.

IsChecked

Specifies whether the check box associated with the item is checked.

IsDragOver

Specifies whether a dragged object is over the area of the current control.

IsFocused

Specifies whether the control is in 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.

IsSelected

Specifies whether the item is selected.

IsVisible

Specifies whether the control is visible.

ItemData

Specifies various data that can be attached to a TListBoxItem in order to be shown in the list box.

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.

OnActivate

<Delphi property OnActivate of type TControl at 1619D6A7410>

OnApplyStyleLookup

<Delphi property OnApplyStyleLookup of type TListBoxItem at 1619DC402C0>

OnCanFocus

<Delphi property OnCanFocus of type TControl at 1619D6A6980>

OnClick

<Delphi property OnClick of type TListBoxItem at 1619DC40C80>

OnDblClick

<Delphi property OnDblClick of type TControl at 1619D6A68B0>

OnDeactivate

<Delphi property OnDeactivate of type TControl at 1619D6A74E0>

OnDragDrop

<Delphi property OnDragDrop of type TListBoxItem at 1619DC40600>

OnDragEnd

<Delphi property OnDragEnd of type TListBoxItem at 1619DC406D0>

OnDragEnter

<Delphi property OnDragEnter of type TListBoxItem at 1619DC40390>

OnDragLeave

<Delphi property OnDragLeave of type TListBoxItem at 1619DC40460>

OnDragOver

<Delphi property OnDragOver of type TListBoxItem at 1619DC40530>

OnEnter

<Delphi property OnEnter of type TControl at 1619D6A6A50>

OnExit

<Delphi property OnExit of type TControl at 1619D6A6B20>

OnGesture

<Delphi property OnGesture of type TControl at 1619D6A7B60>

OnKeyDown

<Delphi property OnKeyDown of type TControl at 1619D6A6640>

OnKeyUp

<Delphi property OnKeyUp of type TControl at 1619D6A6710>

OnMouseDown

<Delphi property OnMouseDown of type TListBoxItem at 1619DC407A0>

OnMouseEnter

<Delphi property OnMouseEnter of type TListBoxItem at 1619DC40AE0>

OnMouseLeave

<Delphi property OnMouseLeave of type TListBoxItem at 1619DC40BB0>

OnMouseMove

<Delphi property OnMouseMove of type TListBoxItem at 1619DC40870>

OnMouseUp

<Delphi property OnMouseUp of type TListBoxItem at 1619DC40940>

OnMouseWheel

<Delphi property OnMouseWheel of type TListBoxItem at 1619DC40A10>

OnPaint

<Delphi property OnPaint of type TListBoxItem at 1619DC40E20>

OnPainting

<Delphi property OnPainting of type TListBoxItem at 1619DC40D50>

OnResize

<Delphi property OnResize of type TListBoxItem at 1619DC40EF0>

OnResized

<Delphi property OnResized of type TListBoxItem at 1619DC40FC0>

OnTap

<Delphi property OnTap of type TControl at 1619D6A7C30>

Opacity

Specifies the control opacity.

Owner

Indicates the component that is responsible for streaming and freeing this component.

Padding

Aligns the component to the padding points of other components.

Parent

Specifies the parent component of this FMX object.

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.

PopupMenu

Specifies the context (pop-up) menu object.

Position

Aligns the component to the position points of other components (Bounds points).

PrefixStyle

Determines whether the ampersand character (&) is considered as a special prefix character.

Pressed

Indicates whether the control is currently pressed.

PressedPosition

A point that indicates where exactly on the control the click occured.

ResultingTextSettings

Keeps final values of text representation properties.

Root

Specifies the root parent of this object.

Scale

Specifies the scale of the control.

Scene

Specifies the current scene in which the control is drawn.

Selectable

Embarcadero Technologies does not currently have any additional information.

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

<Delphi indexed property StylesData of type TStyledControl at 1619D27AB40>

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 rendered over the surface of this TTextControl object.

TextAlign

Specifies how the text will be displayed in terms of horizontal alignment.

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

Specifies whether the component appears onscreen.

Width

Specifies the horizontal size of the control (in pixels).

WordWrap

Specifies whether the text inside the TTextControl object wraps when it is longer than the width of the control.

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.

ApplyTriggerEffect(AInstance: FmxObject, ATrigger: string)#

Applies the specified mouse trigger effect to all the children of this FMX object that are of type TEffect. FMX.ListBox.TListBoxItem.ApplyTriggerEffect inherits from FMX.Controls.TControl.ApplyTriggerEffect. All content below this line refers to FMX.Controls.TControl.ApplyTriggerEffect. Applies the specified mouse trigger effect to all the children of this FMX object that are of type TEffect. ApplyTriggerEffect iterates through all the children of this FMX object and, if one of them is of type TEffect, applies the mouse trigger given through the ATrigger parameter (which can be ‘IsMouseOver’, ‘IsMouseOver’, ‘IsDragOver’, and so on). AInstance specifies the instance of the FMX object to which the trigger effect is applied.

AutoTranslate#

Specifies whether the control’s text should be translated. Set AutoTranslate to True to permit the control text (if it exists) to be translated, when the control is used in an application available in several languages. Set it to False to keep the text unchanged.

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.

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.

Create(AOwner: Component)#

Allocates memory and constructs a safely initialized instance of a component. Allocates memory and constructs a safely initialized instance of a component. FMX.ListBox.TListBoxItem.Create inherits from System.Classes.TComponent.Create. All content below this line refers to System.Classes.TComponent.Create. Allocates memory and constructs a safely initialized instance of a component. All objects have a Create method that constructs the object. TComponent redefines Create so that, for components, Create also:

Establishes the relationship of a component and its Owner, as indicated by the AOwner parameter. Sets the ComponentStyle property to csInheritable, meaning that the component can be inherited by a descendent form type. It is not necessary to explicitly create components added in the Form Designer. These components are created automatically when the application is run, and they are destroyed when the application is closed. For components created programmatically, that is, not created in the Form Designer, call Create and pass in an owner component as the AOwner parameter. The owner disposes of the component when it is destroyed. If the component is not owned, then use Free when it needs to be destroyed.

Tip: When passing in Self as the Owner parameter, consider what Self references. If a component creates another component in one of its methods, then Self refers to the first component and not the component being created, which is then owned by the first component. Note: The TComponent constructor is virtual in part to allow polymorphic instantiation of class references. This is critical to the streaming system and to the Form Designer. Do not forget to use the override directive when declaring a new component’s Create constructor.

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

Data#

Stores a Tvalue, which is a data structure that can store different kinds of data types. FMX.ListBox.TListBoxItem.Data inherits from FMX.Types.TFmxObject.Data. All content below this line refers to FMX.Types.TFmxObject.Data. Stores a Tvalue, which is a data structure that can store different kinds of data types. Data has no predefined meaning. Although Data is used for LiveBinding, any succesor override this behavior. Then, the behaviour of Data is based on the type of its value.

Note: Do not use this member. It is for internal use only.

DefaultStyleLookupName#

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

Destroy()#

Disposes of the component and its owned components. Disposes of the component and its owned components. FMX.ListBox.TListBoxItem.Destroy inherits from System.Classes.TComponent.Destroy. All content below this line refers to System.Classes.TComponent.Destroy. Disposes of the component and its owned components. Do not call Destroy directly. Call Free instead. Free verifies that the component is not nil, and only then calls Destroy. Never explicitly free a component in one of its own event handlers, nor free a component from the event handler of a component that it owns or contains. To destroy a form, call its Release method. Release waits for all the form’s event handlers and the event handlers of the form’s components to finish executing before destroying the form.

Note: A form owns all the controls and nonvisual components that are placed on it in design mode. When it is freed, all of these components are automatically freed as well. By default, all forms are owned by the global Application object. When an application terminates, it frees the global Application object, which frees all forms. For objects that are not components, and for components created with a nil owner, be sure to call Free after finishing with the object; otherwise the memory allocated for the object will be lost until the application terminates.

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.

EnableDragHighlight#

Specifies whether the control is highlighted when the dragged object is over it.

Font#

Specifies the font to use when rendering the text. Set Font to specify the font to use when rendering the text. 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.

GetParentComponent()#

Returns the containing component. Returns the containing component. FMX.ListBox.TListBoxItem.GetParentComponent inherits from System.Classes.TComponent.GetParentComponent. All content below this line refers to System.Classes.TComponent.GetParentComponent. Returns the containing component. GetParentComponent returns a reference to the component that contains the current component, or nil if there is no container. Use HasParent to determine whether a component has a containing component. For example, a button on a panel on a form returns the panel, the panel returns the form, and the form returns nil.

Height#

Height specifies the vertical size of the control (in dp). Use the Height property to read or change the height of the control.

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.

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.

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.

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;

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

  2. Set the TPathLabel HitTest property to True. Run the application and click the label. The OnClick event is fired for the TPathLabel.

ImageIndex#

Defines the zero-based index enumerating images in the Images list of images. If you use a non-existing ImageIndex value to access an image in the Images list, then no image is retrieved and no exception is raised. The usual default value is -1. Call ImagesChanged when ImageIndex is changed.

Images#

Defines the reference to a TCustomImageList list of images to be used to draw images on the component. If the TCustomImageList list is empty, then Images is nil/null. Call ImagesChanged when Images is changed.

Inflate()#

Call this procedure to get and apply its style lookup.

IsChecked#

Specifies whether the check box associated with the item is checked.

IsSelected#

Specifies whether the item is selected. If IsSelected is True, the item appears as selected inside its parent component.

ItemData#

Specifies various data that can be attached to a TListBoxItem in order to be shown in the list box. Use the ItemData property in order to attach various data to a list box item. This data can then be displayed in the list box.

ItemData has four sub-properties:

Accessory - lets you add to the selected list box item one of the following items: Checkmark icon Detail icon More icon No icon (this is the default) Bitmap - lets you add a bitmap image to your item. Detail - lets you add an additional text that describes your list box item. Text - allows you to change the text displayed on your list box item.

In the picture above, two list box items are present in the list:

The first one has a bitmap image, additional text description and no accessory icon. The second one has a bitmap image, additional text description and the Detail accessory icon.

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.

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.

NeedStyleLookup()#

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

OnApplyStyleLookup#

<Delphi property OnApplyStyleLookup of type TListBoxItem at 1619DC402C0>

OnClick#

<Delphi property OnClick of type TListBoxItem at 1619DC40C80>

OnDragDrop#

<Delphi property OnDragDrop of type TListBoxItem at 1619DC40600>

OnDragEnd#

<Delphi property OnDragEnd of type TListBoxItem at 1619DC406D0>

OnDragEnter#

<Delphi property OnDragEnter of type TListBoxItem at 1619DC40390>

OnDragLeave#

<Delphi property OnDragLeave of type TListBoxItem at 1619DC40460>

OnDragOver#

<Delphi property OnDragOver of type TListBoxItem at 1619DC40530>

OnMouseDown#

<Delphi property OnMouseDown of type TListBoxItem at 1619DC407A0>

OnMouseEnter#

<Delphi property OnMouseEnter of type TListBoxItem at 1619DC40AE0>

OnMouseLeave#

<Delphi property OnMouseLeave of type TListBoxItem at 1619DC40BB0>

OnMouseMove#

<Delphi property OnMouseMove of type TListBoxItem at 1619DC40870>

OnMouseUp#

<Delphi property OnMouseUp of type TListBoxItem at 1619DC40940>

OnMouseWheel#

<Delphi property OnMouseWheel of type TListBoxItem at 1619DC40A10>

OnPaint#

<Delphi property OnPaint of type TListBoxItem at 1619DC40E20>

OnPainting#

<Delphi property OnPainting of type TListBoxItem at 1619DC40D50>

OnResize#

<Delphi property OnResize of type TListBoxItem at 1619DC40EF0>

OnResized#

<Delphi property OnResized of type TListBoxItem at 1619DC40FC0>

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.

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.

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.

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.

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.

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.

Selectable#

Embarcadero Technologies does not currently have any additional information.

SetIsSelectedInternal(Value: Boolean, UserChange: Boolean)#

Processes the selection of an item. Sets the value of the IsSelected property, triggers the selection animation and calls the ItemStateChanged method of the listbox selection controller. The UserChange specifies whether the selection is initiated by an user action (as opposed to by a code call).

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.

StyleLookup#

Specifies the name of the resource object to which the current TStyledControl is linked. StyleLookup becomes especially useful with the introduction of Metropolis UI styles. Metropolis UI styles contain lots of styles for buttons, panes, lists, and other control elements. Each control has the default style, but you can change this default style to any style accessible for the class of a control. The StyleLookup property can be used to specify such additional style. In the Object Inspector, you can select in the StyleLookup property the name of an additional style for the control – like searchbuttontext – from the general style loaded into the TStyleBook or from the default style for the used platform. See StyleLookup Support for Metropolis UI Controls.

Note: At design time, using the StyleLookup property of a control in any form in the current project group you can access any custom style defined in any TStyleBook component used in the current project group. That is, even if the form does not have a particular TStyleBook component, controls from this form can use custom styles defined in this TStyleBook component (if this TStyleBook component is used in any form in the current project group). At run time, only styles in the current project and only after an owner of the TStyleBook containing these styles is already created can be accessed.

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.

TabOrder#

Indicates the position of the control in its parent’s tab order. TabOrder is the order in which child controls are visited when the user presses the TAB key. The control with the TabOrder value of 0 is the control that has the focus when the form first appears. Initially, the tab order is always the order in which the controls were added to the form. The first control added to the form has a TabOrder value of 0, the second is 1, the third is 2, and so on. Change this by changing the TabOrder property. Each control has a unique tab-order value within its parent. Assigning TabOrder a value greater than the number of controls contained in the parent control moves the control to the end of the tab order. The control does not take on the assigned value of TabOrder, but instead is given the number that ensures that the control is the last in the tab order.

TabStop#

Embarcadero Technologies does not currently have any additional information.

Text#

Specifies the text that will be rendered over the surface of this TTextControl object. Set the Text property to specify the text that will be displayed by this TTextControl. Text can be any string. If there are any effects already applied before changing the Text property, they will be preserved for the new text. Also, the surface of this TTextControl is repainted. In the Text property you can define an accelerator key. On Windows platforms, an accelerator key is shown as an underlined letter. To specify an accelerator key, precede an <accelerator_letter> with an ampersand & character. The letter after the ampersand appears underlined. For example, to set the S character as an accelerator key for a Save button, type &Save. On Windows platforms, accelerator keys enable the user to access controls pressing Alt+<accelerator_letter> key combination. When run on not Windows platforms, a single ampersand is simply stripped from the text. To show a single ampersand & character in a Text property specify doubled ampersand && characters.

Tip: If you specify a new text string that is exactly the same as the one already displayed, the effects will not be re-updated and this TTextControl object will not be repainted. Note: FMX.ExtCtrls.TPopupBox.Text is not a writable property in the same way as FMX.Controls.TTextControl.Text. The FMX.ExtCtrls.TPopupBox.Text property cannot be “any string”, but instead must be just one of the strings in the FMX.ExtCtrls.TPopupBox.Items property and, in this case, FMX.ExtCtrls.TPopupBox.ItemIndex is updated accordingly.

TextAlign#

Specifies how the text will be displayed in terms of horizontal alignment. The TextAlign property specifies how the TTextControl object will display the text in terms of horizontal alignment. TextAlign can have one of the following values (defined in TTextAlign):

Center (default)–aligns the text on a horizontal axis, at the middle of the TTextControl object. Leading–aligns the text on a horizontal axis, at the leftmost position inside the TTextControl object. Trailing–aligns the text on a horizontal axis, at the rightmost position inside the TTextControl object. When you use text representation properties stored in ITextSettings.TextSettings, remember that TextAlign corresponds to HorzAlign.

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.

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.

Width#

Specifies the horizontal size of the control (in pixels). Use the Width property to read or change the width of the control.

WordWrap#

Specifies whether the text inside the TTextControl object wraps when it is longer than the width of the control. Set WordWrap to True to allow the TTextControl control to display multiple lines of text. When WordWrap is True, text that is too long for the TTextControl object 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 TTextControl. However, in this case, the text that is too long for TTextControl appears truncated. The default value for the WordWrap property is False.