Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
DelphiFMX Documentation
Light Logo Dark Logo
DelphiFMX Documentation
  • Installation
  • Tutorials & Guides
    • Quickstart
    • Example Gallery
    • Frequently Asked Questions
  • Reference Manual
    • DelphiFMX
      • Action
      • ActionList
      • CustomAction
      • CustomActionList
      • CustomViewAction
      • AdapterListView
      • AppearanceListView
      • CustomListView
      • ListView
      • ListViewBase
      • PresentedListView
      • AniIndicator
      • ArcDial
      • BitmapTrackBar
      • Button
      • CalloutPanel
      • CheckBox
      • CornerButton
      • CustomButton
      • CustomCornerButton
      • CustomSwitch
      • CustomTrack
      • Expander
      • ExpanderButton
      • GroupBox
      • ImageControl
      • Label
      • Panel
      • PathLabel
      • PresentedTextControl
      • ProgressBar
      • RadioButton
      • ScrollBar
      • SizeGrip
      • SmallScrollBar
      • SpeedButton
      • Splitter
      • StatusBar
      • Switch
      • Thumb
      • ToolBar
      • Track
      • TrackBar
      • Arc
      • CalloutRectangle
      • CaretRectangle
      • Circle
      • CustomPath
      • Ellipse
      • Image
      • Line
      • PaintBox
      • Path
      • Pie
      • Rectangle
      • RoundRect
      • Selection
      • SelectionPoint
      • Shape
      • Text
      • BaseBindScopeComponent
      • BaseLinkingBindSource
      • BasicBindComponent
      • BindComponentDelegate
      • BindingsList
      • ContainedBindComponent
      • CustomBindingsList
      • CustomLinkControlToField
      • CustomLinkListControlToField
      • CustomLinkPropertyToField
      • LinkControlDelegate
      • LinkControlToField
      • LinkControlToFieldDelegate
      • LinkListControlToField
      • LinkPropertyToField
      • LinkPropertyToFieldDelegate
      • BaseObjectBindSource
      • CustomPrototypeBindSource
      • PrototypeBindSource
      • BaseValueRange
      • CustomValueRange
      • CustomValueRangeAction
      • FileExit
      • FileHideApp
      • FileHideAppOthers
      • HintAction
      • ObjectViewAction
      • SysCommonAction
      • ValueRange
      • ValueRangeAction
      • ViewAction
      • VirtualKeyboard
      • WindowClose
      • BasicAction
      • Collection
      • Component
      • Persistent
      • Strings
      • Bounds
      • ControlSize
      • CustomPopupMenu
      • FmxObject
      • Position
      • BufferedLayout
      • CustomBufferedLayout
      • CameraComponent
      • CustomMediaCodec
      • CustomMediaPlayerAction
      • Media
      • MediaPlayer
      • MediaPlayerControl
      • MediaPlayerCurrentTime
      • MediaPlayerPlayPause
      • MediaPlayerStart
      • MediaPlayerStop
      • MediaPlayerValue
      • MediaPlayerVolume
      • CheckColumn
      • Column
      • CurrencyColumn
      • CustomGrid
      • CustomNumberColumn
      • DateColumn
      • DateTimeColumn
      • DateTimeColumnBase
      • FloatColumn
      • GlyphColumn
      • Grid
      • ImageColumn
      • IntegerColumn
      • PopupColumn
      • ProgressColumn
      • StringColumn
      • StringGrid
      • TimeColumn
      • ColorBox
      • ColorButton
      • ColorComboBox
      • ColorListBox
      • ColorPanel
      • ColorPicker
      • ColorQuad
      • ComboColorBox
      • CustomColorComboBox
      • GradientEdit
      • ComboBox
      • CustomComboBox
      • CustomListBox
      • ListBox
      • ListBoxItem
      • ComboEdit
      • ComboEditBase
      • CustomComboEdit
      • CommonCustomForm
      • CustomForm
      • CustomPopupForm
      • Form
      • Frame
      • ContainedAction
      • ContainedActionList
      • Control
      • CustomControlAction
      • Popup
      • StyledControl
      • StyleBook
      • TextControl
      • CustomEditBox
      • CustomMemo
      • Memo
      • CustomMultiView
      • MultiView
      • CustomPresentedFramedScrollBox
      • CustomPresentedFramedVertScrollBox
      • CustomPresentedHorzScrollBox
      • CustomPresentedScrollBox
      • CustomPresentedVertScrollBox
      • PresentedFramedScrollBox
      • PresentedFramedVertScrollBox
      • PresentedHorzScrollBox
      • PresentedScrollBox
      • PresentedVertScrollBox
      • CustomScrollBox
      • FlowLayout
      • FramedScrollBox
      • FramedVertScrollBox
      • GridLayout
      • GridPanelLayout
      • HorzScrollBox
      • Layout
      • ScaledLayout
      • ScrollBox
      • VertScrollBox
      • Edit
      • CustomEdit
      • FMXBindNavigateAction
      • FMXBindNavigateApplyUpdates
      • FMXBindNavigateDelete
      • FMXBindNavigateEdit
      • FMXBindNavigateFirst
      • FMXBindNavigateInsert
      • FMXBindNavigateLast
      • FMXBindNavigateNext
      • FMXBindNavigatePost
      • FMXBindNavigatePrior
      • FMXBindNavigateRefresh
      • FMXBindNavigateCancel
      • FMXBindNavigateCancelUpdates
      • MainMenu
      • MenuBar
      • MenuItem
      • PopupMenu
      • Object
      • OpenDialog
      • Point
      • PointF
      • Rect
      • RectF
      • Size
      • SizeF
      • SearchBox
      • SpinBox
      • StyleManager
      • Stream
      • StyleStreaming
      • TabControl
      • TabItem
  • Changelog
    • v1.0.3
    • v1.0.4
    • v1.0.5
    • v1.0.6
  • Contributing
Back to top

Popup¶

Qualified name: delphifmx.Popup

class Popup¶

Bases: StyledControl

TPopup provides a pop-up window. Use TPopup to display content in a temporary window. By default, a TPopup content is empty. You can add any number of objects to the TPopup content:

To add a control to the TPopup content, set the Parent property of the control or create it with the TPopup as its owner. To access the TPopup children, use ChildrenCount and Children properties. To position a TPopup, use the following properties:

PlacementRectangle PlacementTarget HorizontalOffset VerticalOffset Placement When TPopup is open, it does not reposition itself if its parent is repositioned. To drag a TPopup together with its parent, set the DragWithParent property to True. TPopup supports animations and graphic effects. The animations and graphic effects are applied to the displayed window, and not to every child of the TPopup. For opacity effects, set the effects directly to the TPopup children. TPopup children do not inherit the animations and effects applied to the parent. If TPopup is not explicitly sized, it is sized by its content. In this case, if an effect is applied that increases the content’s displayed size, part of the content might be obscured. To avoid this, explicitly set the size for TPopup or set its bounds through the BoundsRect, Margins, and Padding properties. To open and explicitly close a TPopup, set the TPopup.IsOpen property to True and False, respectively. (We do not recommend using Popup and ClosePopup.)

Methods

ApplyStyleLookup

TStyledControl.ApplyStyleLookup() Gets and applies the style of a TStyledControl.

BringToFront

Brings this FMX visual object on top of other overlapping visual controls that are on the same form.

HasPopupForm

Returns whether the PopupForm property holds a pop-up form.

Inflate

TStyledControl.Inflate() Call this procedure to get and apply its style lookup.

NeedStyleLookup

TStyledControl.NeedStyleLookup() Call this procedure to indicate that this control requires to get and apply its style lookup.

Popup

TPopup.Popup(AShowModal: bool) -> None Displays the TPopup window.

PopupModal

Returns whether and how the modal form of TPopup closes.

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.

AniDuration

Sets the animation duration during appearing or closing of the pop-up window.

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.

BorderWidth

Embarcadero Technologies does not currently have any additional information.

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.

ClosingAnimation

Is True if the TPopup has a closing animation, False otherwise.

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.

DefaultStyleLookupName

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

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.

DragWithParent

Specifies whether the TPopup is dragged together with its parent.

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.

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.

HideWhenPlacementTargetInvisible

Embarcadero Technologies does not currently have any additional information.

Hint

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

HitTest

Enables the control to capture mouse events.

HorizontalOffset

Sets and gets the horizontal distance between the target origin and the TPopup alignment point.

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.

IsOpen

Is True if the TPopup is dropped down, False otherwise.

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.

ModalResult

Determines whether and how the TPopup closes its modal form.

Name

Specifies the name of the component as referenced in code.

Observers

Indicates the TObservers object added to the TComponent.

OnCanFocus

Callable[[Object, bool], None]:

OnDragDrop

Callable[[Object, DragObject, PointF], None]:

OnDragEnter

Callable[[Object, DragObject, PointF], None]:

OnDragOver

Callable[[Object, DragObject, PointF, DragOperation], None]:

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

ParentClassStyleLookupName

The name of the default style of the parent class of this control.

ParentControl

Specifies the parent control of this control.

ParentedRect

Specifies the bounding rectangle of the control within its parent.

ParentedVisible

Specifies whether all the control's parents are visible.

Placement

Determines how to position the TPopup form relative to a rectangle specified by the PlacementRectangle or PlacementTarget properties, relative to the screen, or relative to the mouse (pointing device) position.

PlacementRectangle

Gets or sets the rectangle element relative to which TPopup is positioned.

PlacementTarget

Gets or sets the target relative to which TPopup is positioned.

PopupFormSize

Sets the size of the TPopup through a TSizeF object.

PopupMenu

Specifies the context (pop-up) menu object.

Position

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

PreferedDisplayIndex

Embarcadero Technologies does not currently have any additional information.

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.

StyleBook

Gets and sets the TPopup stored style.

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

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.

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.

UpdateRect

Specifies the rectangle area of the control that needs to be updated.

UseParentScale

bool:

VCLComObject

Represents information used internally by components that support COM.

VerticalOffset

Sets and gets the vertical distance between the target origin and the TPopup alignment point.

Visible

Specifies whether the component appears onscreen.

Width

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

AdjustSizeValue¶

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

AdjustType¶

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

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

AniDuration¶

Sets the animation duration during appearing or closing of the pop-up window. AniDuration defines time (in seconds) of a custom animation execution. The OnAniTimer event is periodically triggered during the AniDuration time after the pop-up window starts appearing or closing. During the AniDuration time, the AniPosition property changes from 0 to 1 (during opening) and from 1 to 0 (during closing) respectively. The OnAniTimer event handler contains the code that is performed during animation.

Note: AniDuration does not influence on a duration of an external animation (for example TFloatAnimation animation) if such is assigned to the TPopup pop-up window.

Type:

float

ApplyStyleLookup()¶

Gets and applies the style of a TStyledControl.

AutoTranslate¶

Specifies whether the control’s text should be translated

BorderWidth¶

Embarcadero Technologies does not currently have any additional information.

Type:

float

BringToFront()¶

Brings this FMX visual object on top of other overlapping visual controls that are on the same form. FMX.Controls.TPopup.BringToFront inherits from FMX.Types.TFmxObject.BringToFront. All content below this line refers to FMX.Types.TFmxObject.BringToFront. Brings this FMX visual object on top of other overlapping visual controls that are on the same form. You can call BringToFront at run time as in the following code snippet:

Label1.BringToFront;

or, at design time, by right-clicking the FMX visual control and selecting Control > Bring to Front from the pop-up menu.

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

ClosingAnimation¶

Is True if the TPopup has a closing animation, False otherwise.

Type:

bool

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

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

DragWithParent¶

Specifies whether the TPopup is dragged together with its parent. If DragWithParent is set to True, TPopup is dragged too, when its parent is the target of a drag-and-drop operation. The default value is False. For example, the TPopup of a combo box is dragged with its parent.

Type:

bool

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

HasPopupForm()¶

Returns whether the PopupForm property holds a pop-up form. HasPopupForm returns True if PopupForm holds the pop-up form that appears on the screen after the Popup method execution.

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

HideWhenPlacementTargetInvisible¶

Embarcadero Technologies does not currently have any additional information.

Type:

bool

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.

Type:

bool

HorizontalOffset¶

Sets and gets the horizontal distance between the target origin and the TPopup alignment point. To set the target origin and the alignment point, use the PlacementTarget, Placement, and PlacementRectangle properties. HorizontalOffset has no effect if Placement has one of the values: Absolute, Mouse, MouseCenter.

Type:

float

Inflate()¶

Call this procedure to get and apply its style lookup.

IsOpen¶

Is True if the TPopup is dropped down, False otherwise.

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:

Bounds

ModalResult¶

Determines whether and how the TPopup closes its modal form. TModalResult describes possible values of ModalResult. You can check a ModalResult value using the global IsAbortResult, IsAnAllResult, IsNegativeResult, or IsPositiveResult functions and use the StripAllFromResult function to convert the ModalResult value from a constant that refers to “all” to the corresponding simple constant.

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

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

Placement¶

Determines how to position the TPopup form relative to a rectangle specified by the PlacementRectangle or PlacementTarget properties, relative to the screen, or relative to the mouse (pointing device) position. Placement also specifies the behavior of the TPopup form, when it overlaps screen boundaries. The default value is Bottom. TPlacement determines possible values of Placement. Use Placement, PlacementTarget, and PlacementRectangle to set the target origin and the alignment point of TPopup.

Type:

Placement

PlacementRectangle¶

Gets or sets the rectangle element relative to which TPopup is positioned. Use Placement, PlacementTarget, and PlacementRectangle to set the target origin and the alignment point of TPopup. This is an example of a TPopup with PlacementRectangle:

Type:

Bounds

PlacementTarget¶

Gets or sets the target relative to which TPopup is positioned. If PlacementTarget is not set, and TPopup has a parent, TPopup is positioned relative to its parent. If PlacementTarget and Parent are not set, TPopup is positioned relative to the main window. Use Placement, PlacementTarget, and PlacementRectangle to set the target origin and the alignment point of TPopup.

Type:

Control

Popup(AShowModal: bool) → None¶

Displays the TPopup window.

Note: We do not recommend using Popup and ClosePopup. To open and explicitly close a TPopup, set the TPopup.IsOpen property to True and False, respectively. When AShowModal is True, then Popup drops down TPopup as a modal dialog. Popup applies the specified placement and style to TPopup, before making it visible. To set the placement, use the PlacementRectangle, PlacementTarget, HorizontalOffset, VerticalOffset, and Placement properties.

PopupFormSize¶

Sets the size of the TPopup through a TSizeF object. For example, the following code will set up the TPopup Width to 200 and Height to 250: Delphi:

p1.PopupFormSize := TSizeF.Create(200, 250);

C++ Builder:

p1->PopupFormSize = TSizeF->Create(200, 250);

Type:

SizeF

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

PopupModal()¶

Returns whether and how the modal form of TPopup closes. PopupModal returns 0 if the modal form is not closed. Otherwise PopupModal returns the value of the ModalResult property. To change how the modal form of TPopup is closed, set the ModalResult property. You can check a return value using the global IsAbortResult, IsAnAllResult, IsNegativeResult, or IsPositiveResult functions and use the StripAllFromResult function to convert the return value from a constant that refers to “all” to the corresponding simple constant.

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:

Position

PreferedDisplayIndex¶

Embarcadero Technologies does not currently have any additional information.

Type:

int

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

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

StyleBook¶

Gets and sets the TPopup stored style. To create a new style, use the Style Designer. See details here: Style Resource Storage.

Type:

StyleBook

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

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.

Type:

int

UseParentScale¶

bool:

VerticalOffset¶

Sets and gets the vertical distance between the target origin and the TPopup alignment point. To set the target origin and the alignment point, use the PlacementTarget, Placement, and PlacementRectangle properties. VerticalOffset has no effect if Placement has one of the values: Absolute, Mouse, MouseCenter.

Type:

float

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

Next
StyledControl
Previous
CustomControlAction
Copyright © 2020-2023, Embarcadero Python Dev Team
Made with Sphinx and @pradyunsg's Furo
On this page
  • Popup
    • Popup
      • Popup.AdjustSizeValue
      • Popup.AdjustType
      • Popup.Align
      • Popup.AniDuration
      • Popup.ApplyStyleLookup()
      • Popup.AutoTranslate
      • Popup.BorderWidth
      • Popup.BringToFront()
      • Popup.ClipChildren
      • Popup.ClipParent
      • Popup.ClosingAnimation
      • Popup.Cursor
      • Popup.DefaultStyleLookupName
      • Popup.DragMode
      • Popup.DragWithParent
      • Popup.EnableDragHighlight
      • Popup.Enabled
      • Popup.HasPopupForm()
      • Popup.Height
      • Popup.HelpContext
      • Popup.HelpKeyword
      • Popup.HelpType
      • Popup.HideWhenPlacementTargetInvisible
      • Popup.HitTest
      • Popup.HorizontalOffset
      • Popup.Inflate()
      • Popup.IsOpen
      • Popup.Locked
      • Popup.Margins
      • Popup.ModalResult
      • Popup.NeedStyleLookup()
      • Popup.OnCanFocus
      • Popup.OnDragDrop
      • Popup.OnDragEnter
      • Popup.OnDragOver
      • Popup.OnPaint
      • Popup.OnPainting
      • Popup.Opacity
      • Popup.Padding
      • Popup.Placement
      • Popup.PlacementRectangle
      • Popup.PlacementTarget
      • Popup.Popup()
      • Popup.PopupFormSize
      • Popup.PopupMenu
      • Popup.PopupModal()
      • Popup.Position
      • Popup.PreferedDisplayIndex
      • Popup.RotationAngle
      • Popup.RotationCenter
      • Popup.Scale
      • Popup.Size
      • Popup.StyleBook
      • Popup.StyleLookup
      • Popup.StyleState
      • Popup.TabOrder
      • Popup.UseParentScale
      • Popup.VerticalOffset
      • Popup.Visible
      • Popup.Width