Form#

Qualified name: delphivcl.Form

class Form#

Bases: CustomForm

TForm represents a standard application window (form). When you create forms in the Form designer at design time, they are implemented as descendants of TForm. Forms can represent the application’s main window, or dialog boxes, or MDI children. A form can contain other objects, such as TButton, TCheckBox, and TComboBox objects. Examples of forms include TLoginDialog and TPasswordDialog objects.

Methods

`ArrangeIcons`	Arranges the icons of minimized MDI child forms.
`Cascade`	Arranges MDI child forms so they overlap.
`Close`	Closes the wrapped Form
`CloseQuery`	Asked the wrapped Form if it can close
`LoadProps`	Load properties from a .pydfm file
`Next`	Activates the next child form in the form sequence.
`Previous`	Activates the previous MDI child form in the form sequence.
`Release`	Releases (destroys) the wrapped Form
`ShowModal`	Shows the wrapped Form as a modal form
`Tile`	Arranges MDI child forms so that they are all the same size.
`get_MDIChildren`	Embarcadero Technologies does not currently have any additional information.

Attributes

`Action`	Specifies the action associated with the control.
`Active`	Specifies whether the form has focus.
`ActiveControl`	Specifies the control that has focus on the form.
`ActiveMDIChild`	Specifies the MDI child that has focus.
`ActiveOleControl`	Specifies the OLE control on the form that reacts to changes in focus.
`Align`	Determines how the control aligns within its container (parent control).
`AlignDisabled`	Indicates child control realignment disabled.
`AlignWithMargins`	Specifies whether a control should be constrained by margins.
`AlphaBlend`	Specifies whether the form is translucent.
`AlphaBlendValue`	Specifies the degree of translucency on a translucent form.
`Anchors`	Specifies how the control is anchored to its parent.
`AutoScroll`	Indicates whether scroll bars appear automatically on the scrolling windowed control if it is not large enough to display all of its controls.
`AutoSize`	Specifies whether the control sizes itself automatically to accommodate its contents.
`BiDiMode`	Specifies the bidirectional mode for the control.
`BorderIcons`	Specifies which icons appear on the title bar of the form.
`BorderStyle`	Specifies the appearance and behavior of the form border.
`BorderWidth`	Specifies the width of the control's border.
`BoundsRect`	Specifies the bounding rectangle of the control, expressed in the coordinate system of the parent control.
`Brush`	Determines the color and pattern used for painting the background of the control.
`Canvas`	Provides access to the drawing area of the form.
`Caption`	Specifies a text string that identifies the control to the user.
`ClassName`	Returns the TObject.ClassName
`ClientHandle`	Provides access to the handle of the form's internal MDI client window.
`ClientHeight`	Specifies the height of the control's client area in pixels.
`ClientOrigin`	Specifies the screen coordinates (in pixels) of the upper-left corner of a control's client area.
`ClientRect`	Specifies the size of a control's client area in pixels.
`ClientWidth`	Specifies the horizontal size of the control's client area in pixels.
`Color`	Specifies the background color of the control.
`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 21141642500>
`Constraints`	Specifies the size constraints for the control.
`ControlCount`	Returns the number of child controls.
`ControlState`	Specifies the current state of a control at run time.
`ControlStyle`	Determines style characteristics of the control.
`Controls`	<Delphi indexed property Controls of type TWinControl at 211416EE760>
`Ctl3D`	Determines whether a control has a three-dimensional (3-D) or two-dimensional look.
`CurrentPPI`	Embarcadero Technologies does not currently have any additional information.
`Cursor`	Specifies the image used to represent the mouse pointer when it passes into the region covered by the control.
`CustomHint`	CustomHint is a custom hint for the control.
`CustomTitleBar`	Embarcadero Technologies does not currently have any additional information.
`DefaultMonitor`	Specifies the monitor on which the form appears.
`DesignInfo`	Contains information used by the Form designer.
`Designer`	Specifies the designer interface for the form.
`DockClientCount`	Specifies the number of controls that are docked on the windowed control.
`DockClients`	<Delphi indexed property DockClients of type TWinControl at 211416EE520>
`DockManager`	Specifies the control's docking manager interface.
`DockOrientation`	DockOrientation specifies how the control is docked relative to other controls docked in the same parent.
`DockSite`	Specifies whether the control can be the target of drag-and-dock operations.
`DoubleBuffered`	Determines whether the control's image is rendered directly to the window or painted to an in-memory bitmap first.
`DragKind`	Specifies whether the control is being dragged normally or for docking.
`DragMode`	Specifies how the control initiates drag-and-drop or drag-and-dock operations.
`DropTarget`	Specifies whether the form is the target of a drag-and-drop operation.
`Enabled`	Controls whether the control responds to mouse, keyboard, and timer events.
`ExplicitHeight`	Specifies the explicit vertical size of the control in pixels.
`ExplicitLeft`	Specifies the explicit horizontal pixel coordinate of the left edge of a component relative to its parent.
`ExplicitTop`	Specifies the explicit vertical pixel coordinate of the top edge of a component relative to its parent.
`ExplicitWidth`	Specifies the explicit horizontal size of the control in pixels.
`Floating`	Specifies whether the control is floating.
`FloatingDockSiteClass`	Specifies the class of the temporary control that hosts the control when it is floating.
`Font`	Specifies the attributes of text written on or in the control.
`FormState`	Indicates transitional state information about the form.
`FormStyle`	Determines the form's style.
`GlassFrame`	Accesses the Glass Frame under Windows Vista, Windows 7, or later Windows operating systems.
`Handle`	Provides access to the underlying Windows screen object for the control.
`Height`	Specifies the vertical size of the control in pixels.
`HelpContext`	The HelpContext property contains the numeric context ID that identifies the Help topic for the control.
`HelpFile`	Specifies the name of the Help file the form uses to display the Help from.
`HelpKeyword`	The HelpKeyword property 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`	Hint contains the text string that appears when the user moves the mouse over the control.
`HorzScrollBar`	Represents the horizontal scroll bar for the scrolling windowed control.
`HostDockSite`	Specifies the control in which the control is docked.
`Icon`	Specifies the icon that appears when the form is minimized.
`IsDrawingLocked`	IsDrawingLocked property returns True when redrawing for this control is locked.
`KeyPreview`	Specifies whether the form should receive keyboard events before the active control.
`LRDockWidth`	Specifies the width of the control when it is docked horizontally.
`Left`	Specifies the horizontal coordinate of the left edge of a component relative to its parent.
`MDIChildCount`	Specifies the number of open MDI child forms.
`MDIChildren`	<Delphi indexed property MDIChildren of type TForm at 211416EF2A0>
`Margins`	Specifies the margins of the control.
`Menu`	Specifies the form's main menu.
`ModalResult`	Represents the return value of a form that is used as a modal dialog.
`Monitor`	Provides access to the monitor on which the form appears.
`MouseInClient`	Indicates whether the mouse pointer is currently in the client area of the control.
`Name`	Specifies the name of the component as referenced in code.
`ObjectMenuItem`	Represents an OLE object menu item that reacts to selections of OLE objects.
`Observers`	Indicates the TObservers object added to the TComponent.
`OleFormObject`	Specifies the IOleForm interface for an in-place OLE object contained in the form.
`OnActivate`	<Delphi property OnActivate of type TForm at 21141702330>
`OnAfterMonitorDpiChanged`	<Delphi property OnAfterMonitorDpiChanged of type TForm at 21141702400>
`OnAlignInsertBefore`	<Delphi property OnAlignInsertBefore of type TForm at 211417024D0>
`OnAlignPosition`	<Delphi property OnAlignPosition of type TForm at 211417025A0>
`OnBeforeMonitorDpiChanged`	<Delphi property OnBeforeMonitorDpiChanged of type TForm at 21141702670>
`OnCanResize`	<Delphi property OnCanResize of type TForm at 21141702740>
`OnClick`	<Delphi property OnClick of type TForm at 21141702810>
`OnClose`	<Delphi property OnClose of type TForm at 211417028E0>
`OnCloseQuery`	<Delphi property OnCloseQuery of type TForm at 211417029B0>
`OnConstrainedResize`	<Delphi property OnConstrainedResize of type TForm at 21141702A80>
`OnContextPopup`	<Delphi property OnContextPopup of type TForm at 21141702B50>
`OnCreate`	<Delphi property OnCreate of type TForm at 21141702C20>
`OnDblClick`	<Delphi property OnDblClick of type TForm at 21141702CF0>
`OnDeactivate`	<Delphi property OnDeactivate of type TForm at 21141702E90>
`OnDestroy`	<Delphi property OnDestroy of type TForm at 21141702DC0>
`OnDockDrop`	<Delphi property OnDockDrop of type TForm at 21141702F60>
`OnDockOver`	<Delphi property OnDockOver of type TForm at 21141703030>
`OnDragDrop`	<Delphi property OnDragDrop of type TForm at 21141703100>
`OnDragOver`	<Delphi property OnDragOver of type TForm at 211417031D0>
`OnEndDock`	<Delphi property OnEndDock of type TForm at 211417032A0>
`OnGesture`	<Delphi property OnGesture of type TForm at 21141703370>
`OnGetSiteInfo`	<Delphi property OnGetSiteInfo of type TForm at 21141703440>
`OnHelp`	<Delphi property OnHelp of type TForm at 211417035E0>
`OnHide`	<Delphi property OnHide of type TForm at 21141703510>
`OnKeyDown`	<Delphi property OnKeyDown of type TForm at 211417036B0>
`OnKeyPress`	<Delphi property OnKeyPress of type TForm at 21141703780>
`OnKeyUp`	<Delphi property OnKeyUp of type TForm at 21141703850>
`OnMouseActivate`	<Delphi property OnMouseActivate of type TForm at 21141703920>
`OnMouseDown`	<Delphi property OnMouseDown of type TForm at 211417039F0>
`OnMouseEnter`	<Delphi property OnMouseEnter of type TForm at 21141703AC0>
`OnMouseLeave`	<Delphi property OnMouseLeave of type TForm at 21141703B90>
`OnMouseMove`	<Delphi property OnMouseMove of type TForm at 21141703C60>
`OnMouseUp`	<Delphi property OnMouseUp of type TForm at 21141703D30>
`OnMouseWheel`	<Delphi property OnMouseWheel of type TForm at 21141703E00>
`OnMouseWheelDown`	<Delphi property OnMouseWheelDown of type TForm at 21141703ED0>
`OnMouseWheelUp`	<Delphi property OnMouseWheelUp of type TForm at 21141703FA0>
`OnPaint`	<Delphi property OnPaint of type TForm at 21141704070>
`OnResize`	<Delphi property OnResize of type TForm at 21141704140>
`OnShortCut`	<Delphi property OnShortCut of type TForm at 21141704210>
`OnShow`	<Delphi property OnShow of type TForm at 211417042E0>
`OnStartDock`	<Delphi property OnStartDock of type TForm at 211417043B0>
`OnUnDock`	<Delphi property OnUnDock of type TForm at 21141704480>
`Owner`	Indicates the component that is responsible for streaming and freeing this component.
`Padding`	Specifies the padding of a control.
`Parent`	Specifies the parent of the control.
`ParentBiDiMode`	Specifies whether the control uses its parent's BiDiMode.
`ParentCustomHint`	Specifies where a control looks for its custom hint.
`ParentDoubleBuffered`	ParentDoubleBuffered defers the DoubleBuffered property of this component to the value of the parent's DoubleBuffered property.
`ParentFont`	Specifies where a control looks for its font information.
`ParentWindow`	Reference to parent's underlying control.
`PixelsPerInch`	Embarcadero Technologies does not currently have any additional information.
`PopupMenu`	Specifies the pop-up menu associated with the control.
`PopupMode`	Controls how the top-level form behaves with respect to Window's WS_POPUP style.
`PopupParent`	Sets an order for stacked forms that users cannot change.
`Position`	Represents the size and placement of the form.
`PrintScale`	Represents the proportions of a printed form.
`RedrawDisabled`	RedrawDisabled property returns True when redrawing for this control is locked.
`ScaleFactor`	Embarcadero Technologies does not currently have any additional information.
`Scaled`	Specifies whether the form is sized according to the value of the PixelsPerInch property.
`ScreenSnap`	Specifies whether form snaps to edge of screen.
`ShowHint`	ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control.
`Showing`	Indicates whether the control is showing on the screen.
`SnapBuffer`	Specifies distance for screen snap.
`StyleElements`	Specifies the style elements that are used by the control.
`StyleName`	Embarcadero Technologies does not currently have any additional information.
`TBDockHeight`	Specifies the height of the control when it is docked vertically.
`TabOrder`	Indicates the position of the control in its parent's tab order.
`TabStop`	Determines whether the user can tab to a control.
`Tag`	Stores a NativeInt integral value as a part of a component.
`TaskbarHandler`	Embarcadero Technologies does not currently have any additional information.
`TileMode`	Represents how MDI child forms are arranged when the Tile method is called.
`TipMode`	TipMode indicates whether TabTip (onscreen keyboard equivalent) opens or closes when the control receives focus or if it receives a gesture.
`Top`	Specifies the Y coordinate of the upper-left corner of a control, relative to its parent or containing control in pixels.
`Touch`	Specifies the touch manager component associated with the control.
`TransparentColor`	Specifies whether a color on the form appears transparent.
`TransparentColorValue`	Indicates the color on the form that appears transparent when TransparentColor is true.
`UndockHeight`	Specifies the height of the control when it is floating.
`UndockWidth`	Specifies the width of the control when it is floating.
`UseDockManager`	Specifies whether the docking manager is used in drag-and-dock operations.
`VCLComObject`	Represents information used internally by components that support COM.
`VertScrollBar`	Represents the vertical scroll bar for the scrolling windowed control.
`Visible`	Specifies whether the component appears onscreen.
`VisibleDockClientCount`	Specifies the number of visible controls that are docked on the windowed control.
`Width`	Specifies the horizontal size of the control or form in pixels.
`WindowMenu`	Specifies the Window menu for an MDI parent form.
`WindowProc`	<Delphi property WindowProc of type TControl at 211418EC1C0>
`WindowState`	Represents how the form appears on the screen.

Action#: Specifies the action associated with the control. Action is the action object that is associated with the control. Actions allow an application to centralize the response to user commands. When a control is associated with an action, the action determines the appropriate properties and events of the control (such as whether the control is enabled or how it responds to an OnClick event). To create actions at design time, place an action list component on a form or data module. Double-click the action list to bring up the action list editor. Add actions in the editor using its context menu. Once the actions have been added using the Action List editor, they appear in the drop-down list for the Action property in the Object Inspector.

ActiveControl#

Specifies the control that has focus on the form. Use ActiveControl to get or set the control that has focus on the form. Only one control can have focus at a given time in an application. If the form does not have focus, ActiveControl is the control on the form that will receive focus when the form receives focus.

Note: When focus shifts to another control, ActiveControl is updated before the OnExit event occurs.

ActiveMDIChild#: Specifies the MDI child that has focus. Use ActiveMDIChild to get the MDI child that has focus. If the form is not an MDI parent (that is, if the FormStyle property of the form is not fsMDIForm), ActiveMDIChild returns nil (Delphi) or NULL (C++).

Align#

Determines how the control aligns within its container (parent control). Use Align to align a control to the top, bottom, left, or right of a form or panel and have it remain there even if the size of the form, panel, or component that contains the control changes. When the parent is resized, an aligned control also resizes so that it continues to span the top, bottom, left, or right edge of the parent. For example, to use a panel component with various controls on it as a tool palette, change the panel’s Align value to alLeft. The value of alLeft for the Align property of the panel guarantees that the tool palette remains on the left side of the form and always equals the client height of the form. The default value of Align is alNone, which means a control remains where it is positioned on a form or panel.

Tip: If Align is set to alClient, the control fills the entire client area so that it is impossible to select the parent form by clicking it. In this case, select the parent by selecting the control on the form and pressing ESC, or by using the Object Inspector. Any number of child components within a single parent can have the same Align value, in which case they stack up along the edge of the parent. The child controls stack up in z-order. To adjust the order in which the controls stack up, drag the controls into their desired positions.

Note: To cause a control to maintain a specified relationship with an edge of its parent, but not necessarily lie along one edge of the parent, use the Anchors property instead.

AlphaBlend#

Specifies whether the form is translucent. Set AlphaBlend to specify that the form represents a layered window that allows a translucent color. The AlphaBlendValue property specifies the degree of translucency.

Note: AlphaBlend does not work on all systems. The application must be running under Windows 2000 or better, and the machine must be a P90 or better.

AlphaBlendValue#

Specifies the degree of translucency on a translucent form. Set AlphaBlendValue to a value between 0 and 255 to indicate the degree of translucency when the AlphaBlend property is true. A value of 0 indicates a completely transparent window. A value of 255 indicates complete opacity.

Note: AlphaBlendValue only has an effect when the AlphaBlend property is true.

Anchors#

Specifies how the control is anchored to its parent. Use Anchors to ensure that a control maintains its current position relative to an edge 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. If a control is anchored to opposite edges of its parent, the control stretches when its parent is resized. For example, if a control has its Anchors property set to [akLeft, akRight], the control stretches when the width of its parent changes. Anchors is enforced only when the parent is resized. Thus, for example, if a control is anchored to opposite edges of a form at design time and the form is created in a maximized state, the control is not stretched because the form is not resized after the control is created.

Note: If a control should maintain contact with three edges of its parent (hugging one side of the parent and stretching the length of that side), use the Align property instead. Unlike Anchors, Align allows controls to adjust to changes in the size of other aligned sibling controls as well as changes to the parent’s size.

ArrangeIcons()#: Arranges the icons of minimized MDI child forms. Use ArrangeIcons to arrange the icons of minimized MDI child forms so they are evenly spaced and don’t overlap. ArrangeIcons works only if the form is an MDI parent form (that is, if the form’s FormStyle property is fsMDIForm).

AutoScroll#: Indicates whether scroll bars appear automatically on the scrolling windowed control if it is not large enough to display all of its controls. If AutoScroll is true, the scroll bars appear automatically when necessary. For example, if the user resizes the control so that some of its controls are partially obscured, scroll bars appear. If AutoScroll is false, scroll bars don’t appear automatically. In this case, use the HorzScrollBar and VertScrollBar properties to make scroll bars appear.

AutoSize#: Specifies whether the control sizes itself automatically to accommodate its contents. Use AutoSize to specify whether the control sizes itself automatically. When AutoSize is True, the control resizes automatically when its contents change. By default, AutoSize is False.

BiDiMode#: Specifies the bidirectional mode for the control. Use BiDiMode to enable the control to adjust its appearance and behavior automatically when the application runs in a locale that reads from right to left instead of left to right. The bidirectional mode controls the reading order for the text, the placement of the vertical scroll bar, and whether the alignment is changed. Alignment does not change for controls that are known to contain number, date, time, or currency values. For example, with data-aware controls, the alignment does not change for the following field types: ftSmallint, ftInteger, ftWord, ftFloat, ftCurrency, ftBCD, ftDate, ftTime, ftDateTime, ftAutoInc.

BorderIcons#

Specifies which icons appear on the title bar of the form. Use BorderIcons to get or set the icons that appear on the title bar of the form. BorderIcons can include any of the following TBorderIcons values:

Value

Meaning

biSystemMenu

The form has a Control menu (also known as a System menu).

biMinimize

The form has a Minimize button

biMaximize

The form has a Maximize button

biHelp

If BorderStyle is bsDialog or biMinimize and biMaximize are excluded, a question mark appears in the form’s title bar and when clicked, the cursor changes to crHelp; otherwise,no question mark appears.

Note: Certain combinations of the BorderIcons and BorderStyle properties are mutually exclusive. For example, BorderIcons biMax, biMin with BorderStyle of bsDialog are mutually exclusive.

BorderStyle#

Specifies the appearance and behavior of the form border. Use BorderStyle to get or set the appearance and behavior of the form border. BorderStyle can be any of the following TForm BorderStyle values:

Value

Meaning

bsDialog

Not resizable; no minimize/maximize menu

bsSingle

Not resizable; minimize/maximize menu

bsNone

Not resizable; no visible border line

bsSizeable

Standard resizable border

bsToolWindow

like bsSingle but with a smaller caption

bsSizeToolWin

like bsSizeable with a smaller caption

Note: Changing the border style of an MDI child form to bsDialog or bsNone has no effect.

BorderWidth#: Specifies the width of the control’s border. Use BorderWidth to get or set the width of the control’s border. Graphics or text drawn by the control is clipped to the area within the border.

Caption#

Specifies a text string that identifies the control to the user. Use Caption to specify the text string that labels the control. To underline a character in a Caption that labels a component, include an ampersand (&) before the character. This type of character is called an accelerator character. The user can then select the component by pressing ALT while typing the underlined character. To display an ampersand character in the caption, use two ampersands (&&).

Notes: Controls that display text use either the Caption property or the Text property to specify the text value. The property that is used depends on the type of control. In general, Caption is used for text that appears as a window title or label, while Text is used for text that appears as the content of a control. For some controls, such as TButton, it is not possible to change the color of the Caption. If you want to change the color of a button caption, you should use an alternate button type such as TSpeedButton or TBitBtn instead of TButton. With either TSpeedButton or TBitBtn, you can change the color of the Caption property by using the Font property. For TLinkLabel, an HTML tag is declared inside the Caption property either at run time or at design time.

Cascade()#: Arranges MDI child forms so they overlap. Use Cascade to arrange MDI child forms so they overlap. Cascade works only if the form is an MDI parent form (that is, if the form’s FormStyle property is fsMDIForm).

ClientHandle#

Provides access to the handle of the form’s internal MDI client window. Use ClientHandle to get the handle for the form’s internal MDI client window. ClientHandle is meaningful only if the form is an MDI parent (that is, if the form’s FormStyle property is set to fsMDIForm).

Note: Use the Handle property instead to get the handle to the form window itself.

ClientHeight#: Specifies the height of the control’s client area in pixels. Use ClientHeight to read or change the height of the control’s client area. For TControl, ClientHeight is the same as Height. Derived classes may implement a ClientHeight property that differs from Height. For example, the ClientHeight of a form is the value of the Height property minus the height of the title bar, resize border, and scroll bars.

ClientWidth#: Specifies the horizontal size of the control’s client area in pixels. Use ClientWidth to read or change the width of the control’s client area. ClientWidth is equivalent to ClientRect.Right. For TControl, ClientWidth is the same as Width. Derived classes may implement a ClientWidth property that differs from Width. For example, the ClientWidth of a form is the value of the Width property minus the width of the resize border and scroll bars.

Close()#: Closes the wrapped Form

CloseQuery()#: Asked the wrapped Form if it can close

Color#: Specifies the background color of the control. Use Color to read or change the background color of the control. If a control’s Vcl.Controls.TControl.ParentColor property is True, then changing the Color property of the control’s parent automatically changes the Color property of the control. When the value of the Color property is changed, the control’s ParentColor property is automatically set to False. The Color of a TLabel is always the color of the background unless you set TLabel.Transparent to False.

Constraints#

Specifies the size constraints for the control. Use Constraints to specify the minimum and maximum width and height of the control. When Constraints contains maximum or minimum values, the control cannot be resized to violate those constraints.

Note: Constraints apply to the height of the form. However, the height of the form depends on how large Windows makes the title bar. For example, Windows XP uses much larger title bars than other windowing systems. To work around this, note the ClientHeight when you design your form and set the constraints in the FormCreate event. In the following example, ClientHeight is represented by x: Constraints.MinHeight?:= x + Height - ClientHeight. Warning: Do not set up constraints that conflict with the value of the Align or Anchors property. When these properties conflict, the response of the control to resize attempts is not well-defined.

Ctl3D#

Determines whether a control has a three-dimensional (3-D) or two-dimensional look. Ctl3D is provided for backward compatibility. It is not used by 32-bit versions of Windows or NT4.0 and later, with the exception of Windows XP Home, where it is used on occasion. On earlier platforms, Ctl3D controlled whether the control had a flat or beveled appearance.

Note RAD Studio no longer supports Windows Vista or earlier.

CustomTitleBar#: Embarcadero Technologies does not currently have any additional information.

DefaultMonitor#

Specifies the monitor on which the form appears. Use DefaultMonitor to associate a form with a particular monitor in a multi-monitor application. The following table lists the possible values:

Value

Meaning

dmDesktop

No attempt is made to position the form on a specific monitor.

dmPrimary

The form is positioned on the first monitor listed in the global screen object’s Monitors property.

dmMainForm

The form appears on the same monitor as the application’s main form.

dmActiveForm

The form appears on the same monitor as the currently active form.

Note: DefaultMonitor has no effect if the application does not have a main form.

DockManager#: Specifies the control’s docking manager interface. Use DockManager to specify the control’s docking manager. The docking manager handles the layout of docking zones (where controls are docked) and any painting associated with docking zones. If you set DockSite and UseDockManager to true, but do not assign a value to DockManager, the windowed control generates a default docking manager, using the global DefaultDockTreeClass variable.

DockSite#

Specifies whether the control can be the target of drag-and-dock operations. Set DockSite to true to allow other controls to be docked to this windowed control.

Code Examples Docking (Delphi) Docking (C++)

DoubleBuffered#

Determines whether the control’s image is rendered directly to the window or painted to an in-memory bitmap first. When DoubleBuffered is false, the windowed control paints itself directly to the window. When DoubleBuffered is true, the windowed control paints itself to an in-memory bitmap that is then used to paint the window. Double buffering reduces the amount of flicker when the control repaints, but is more memory intensive. When a windowed control is a dock site and has an associated dock manager, it must be double-buffered.

Note: Some controls, such as TRichEdit, can’t paint themselves into a bitmap. For such controls, DoubleBuffered must be set to false.

DragKind#: Specifies whether the control is being dragged normally or for docking. Use DragKind to get or set whether the control participates in drag-and-drop operations or drag-and-dock operations.

DragMode#: Specifies how the control initiates drag-and-drop or drag-and-dock operations. Use DragMode to control when the user can drag the control. Disable the drag-and-drop or drag-and-dock capability at run time by setting the DragMode property value to dmManual. Enable automatic dragging by setting DragMode to dmAutomatic. For more information about dmManual and dmAutomatic, see TDragMode.

Enabled#

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

Note: This property applies to all TControl descendants.

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 Charset, Color, Height, Name , Pitch, Size, or Style of the TFont object.

Note: Changing the font color of the Caption is not supported for some controls (such as TButton). In most cases, there is an alternate control you can use whose Font property will change the color of the caption or text (such as TBitBtn or TSpeedButton).

FormStyle#

Determines the form’s style. Use FormStyle to get or set the form’s style. FormStyle is one of the following values:

Value

Meaning

fsNormal

The form is neither an MDI parent window nor an MDI child window.

fsMDIChild

The form is an MDI child window.

fsMDIForm

The form is an MDI parent window.

fsStayOnTop

This form remains on top of the desktop and of other forms in the project, except any others that also have FormStyle set to fsStayOnTop. If one fsStayOnTop form launches another, neither form will consistently remain on top.

If the form is the main form of an MDI application, its FormStyle property must be set to fsMDIForm.

Note: It is not advisable to change FormStyle at runtime. Warning: TGraphicControl descendants placed in the client area of a form with FormStyle set to fsMDIForm will not paint.

GlassFrame#

Accesses the Glass Frame under Windows Vista, Windows 7, or later Windows operating systems. Use GlassFrame to make your forms Windows Vista or Windows 7 Aero-compatible, displaying a glass effect. GlassFrame is a property of a TGlassFrame object created automatically for any form.

Note: The property is only available for Windows Vista or Windows 7 with Aero. Otherwise, the Glass Frame is ignored.

Height#: Specifies the vertical size of the control in pixels. Use the Height property to read or change the height of the control.

HelpFile#: Specifies the name of the Help file the form uses to display the Help from. If your form should have a Help file different from the default Help file of the application specified using the TApplication.HelpFile property of the global TApplication type object, then use the HelpFile property of the form to specify the name of the Help file the form will use to display the Help from. The Help system specified by TApplication.HelpSystem displays Help topics from the Help file specified by the HelpFile property of the form when the form has the focus.

HorzScrollBar#: Represents the horizontal scroll bar for the scrolling windowed control. Use HorzScrollBar to hide, show, or manipulate the horizontal scroll bar for the scrolling windowed control.

Icon#: Specifies the icon that appears when the form is minimized. Set the Icon property to provide an icon for the form. If Icon is not set, the system provides a default icon when the form is minimized.

KeyPreview#: Specifies whether the form should receive keyboard events before the active control. If KeyPreview is true, keyboard events occur on the form before they occur on the active control. (The active control is specified by the ActiveControl property.) If KeyPreview is false, keyboard events occur only on the active control. Navigation keys (Tab, BackTab, the arrow keys, and so on) are unaffected by KeyPreview because they do not generate keyboard events. Similarly, when a button has focus or when its Default property is true, the Enter key is unaffected by KeyPreview because it does not generate a keyboard events. KeyPreview is false by default.

LoadProps()#: Load properties from a .pydfm file

MDIChildCount#: Specifies the number of open MDI child forms. Use MDIChildCount to get the number of open MDI child forms. MDIChildCount is meaningful only if the form is an MDI parent (that is, if the form’s FormStyle property is set to fsMDIForm).

MDIChildren#: <Delphi indexed property MDIChildren of type TForm at 211416EF2A0>

Menu#: Specifies the form’s main menu. Use Menu to get or set the form’s main menu. At design time, Menu is set to the first TMainMenu component added to the form.

ModalResult#: Represents the return value of a form that is used as a modal dialog.

Next()#: Activates the next child form in the form sequence. Use Next to change the active child form of an MDI parent. For example, if you have three child forms within a parent form and Form2 is the active form, the Next method makes Form3 the active form. Calling Next again makes Form4 active. The next time your application calls Next, the sequence starts over again and Form2 becomes the active form once again. The Next method applies only to forms that are MDI parent forms (have a FormStyle property value of fsMDIForm).

ObjectMenuItem#: Represents an OLE object menu item that reacts to selections of OLE objects. Use ObjectMenuItem to get or set a menu item that becomes enabled or disabled when an OLE object on the form is selected or unselected respectively. The OLE object menu item can be used for standard OLE commands, such as Activate or Convert. (The implementations of these commands are provided by the OLE server.)

OnActivate#: <Delphi property OnActivate of type TForm at 21141702330>

OnAfterMonitorDpiChanged#: <Delphi property OnAfterMonitorDpiChanged of type TForm at 21141702400>

OnAlignInsertBefore#: <Delphi property OnAlignInsertBefore of type TForm at 211417024D0>

OnAlignPosition#: <Delphi property OnAlignPosition of type TForm at 211417025A0>

OnBeforeMonitorDpiChanged#: <Delphi property OnBeforeMonitorDpiChanged of type TForm at 21141702670>

OnCanResize#: <Delphi property OnCanResize of type TForm at 21141702740>

OnClick#: <Delphi property OnClick of type TForm at 21141702810>

OnClose#: <Delphi property OnClose of type TForm at 211417028E0>

OnCloseQuery#: <Delphi property OnCloseQuery of type TForm at 211417029B0>

OnConstrainedResize#: <Delphi property OnConstrainedResize of type TForm at 21141702A80>

OnContextPopup#: <Delphi property OnContextPopup of type TForm at 21141702B50>

OnCreate#: <Delphi property OnCreate of type TForm at 21141702C20>

OnDblClick#: <Delphi property OnDblClick of type TForm at 21141702CF0>

OnDeactivate#: <Delphi property OnDeactivate of type TForm at 21141702E90>

OnDestroy#: <Delphi property OnDestroy of type TForm at 21141702DC0>

OnDockDrop#: <Delphi property OnDockDrop of type TForm at 21141702F60>

OnDockOver#: <Delphi property OnDockOver of type TForm at 21141703030>

OnDragDrop#: <Delphi property OnDragDrop of type TForm at 21141703100>

OnDragOver#: <Delphi property OnDragOver of type TForm at 211417031D0>

OnEndDock#: <Delphi property OnEndDock of type TForm at 211417032A0>

OnGesture#: <Delphi property OnGesture of type TForm at 21141703370>

OnGetSiteInfo#: <Delphi property OnGetSiteInfo of type TForm at 21141703440>

OnHelp#: <Delphi property OnHelp of type TForm at 211417035E0>

OnHide#: <Delphi property OnHide of type TForm at 21141703510>

OnKeyDown#: <Delphi property OnKeyDown of type TForm at 211417036B0>

OnKeyPress#: <Delphi property OnKeyPress of type TForm at 21141703780>

OnKeyUp#: <Delphi property OnKeyUp of type TForm at 21141703850>

OnMouseActivate#: <Delphi property OnMouseActivate of type TForm at 21141703920>

OnMouseDown#: <Delphi property OnMouseDown of type TForm at 211417039F0>

OnMouseEnter#: <Delphi property OnMouseEnter of type TForm at 21141703AC0>

OnMouseLeave#: <Delphi property OnMouseLeave of type TForm at 21141703B90>

OnMouseMove#: <Delphi property OnMouseMove of type TForm at 21141703C60>

OnMouseUp#: <Delphi property OnMouseUp of type TForm at 21141703D30>

OnMouseWheel#: <Delphi property OnMouseWheel of type TForm at 21141703E00>

OnMouseWheelDown#: <Delphi property OnMouseWheelDown of type TForm at 21141703ED0>

OnMouseWheelUp#: <Delphi property OnMouseWheelUp of type TForm at 21141703FA0>

OnPaint#: <Delphi property OnPaint of type TForm at 21141704070>

OnResize#: <Delphi property OnResize of type TForm at 21141704140>

OnShortCut#: <Delphi property OnShortCut of type TForm at 21141704210>

OnShow#: <Delphi property OnShow of type TForm at 211417042E0>

OnStartDock#: <Delphi property OnStartDock of type TForm at 211417043B0>

OnUnDock#: <Delphi property OnUnDock of type TForm at 21141704480>

Padding#: Specifies the padding of a control. Use Padding to specify the padding of a control. This value is an instance of the class TPadding.

ParentBiDiMode#: Specifies whether the control uses its parent’s BiDiMode. Use ParentBiDiMode to get or set whether the control uses its parent’s BiDiMode. When ParentBiDiMode is true, the control’s BiDiMode property is always equal to that of its parent. If ParentBiDiMode is false, the control uses its own BiDiMode property. Set ParentBiDiMode to true for all controls in a form to ensure that the entire user interface adjusts to Middle Eastern locales in a uniform manner. When the value of the control’s BiDiMode property changes, ParentBiDiMode becomes false automatically.

ParentFont#: Specifies where a control looks for its font information. To have a control use the same font as its parent control, set ParentFont to true. If ParentFont is false, the control uses its own Font property. Many controls default ParentFont to true so that all the controls in a form or other container present a uniform appearance. When the value of a control’s Font property changes, ParentFont becomes false automatically. When ParentFont is true for a form, the form uses the default font. Currently, the default font is Tahoma 8 pt.

PopupMenu#: Specifies the pop-up menu associated with the control. Assign a value to PopupMenu to make a pop-up menu appear when the user selects the control and clicks the right mouse button. If the TPopupMenu’s AutoPopup property is True, the pop-up menu appears automatically. If the menu’s AutoPopup property is False, display the menu with a call to its Popup method from the control’s OnContextPopup event handler.

PopupMode#

Controls how the top-level form behaves with respect to Window’s WS_POPUP style. The PopupMode property controls how the top-level form behaves with respect to Window’s WS_POPUP style. A window that has the WS_POPUP style is always above its “owner” in Z-order. You can use the PopupMode property in conjunction with the PopupParent property to avoid the appearance of a hung application caused by a modal dialog showing up behind another form on the screen.

Note: Using the PopupMode property is similar to specifying fsStayOnTop for the FormStyle property, but allows better control over the layering. The PopupMode property is automatically set to pmAuto when the ShowModal method is called. However, this causes the window handle to be recreated, which is not usually desirable. To avoid the re-creation of window handles, you can explicitly set the PopupMode property to pmAuto prior to calling the ShowModal method (such as at design time). Set the PopupMode property to pmExplicit for non-modal design windows such as tool palettes and other floating tool windows. This causes the windows to always remain on top of the main form. In the case of a snapped together design (in which the window is docked to the main form), the design window remains on top of the designer.

Note: For undocked windows, the design window remains above the main form, allowing other top-level forms to obscure the design window. Set the PopupMode property to pmNone if you want the pop-up window to have the pre-Delphi 8 behavior (except for the ShowModal item mentioned above). You can force the Z-Ordering of your forms and create a “stacked” appearance that the user cannot change by setting the PopupParent property to an explicit TCustomForm. If the PopupMode property is pmExplicit and PopupParent is nil, then the Application.MainForm is implicitly used as the PopupParent. If no Application.MainForm is assigned, then Application.Handle is used as the PopupParent. If the PopupMode property is set to pmAuto, Screen.ActiveForm is used as the PopupParent.

PopupParent#: Sets an order for stacked forms that users cannot change. If the PopupMode property is set to pmExplicit and PopupParent is nil, then the Application.MainForm is implicitly used as the PopupParent. If no Application.MainForm is assigned, then Application.Handle is used as the PopupParent. If the PopupMode property is set to pmAuto, Screen.ActiveForm is used as the PopupParent property.

Position#

Represents the size and placement of the form. Use Position to get or set the size and placement of the form. Position can have one of the following TPosition values:

Value

Meaning

poDesigned

The form appears positioned on the screen and with the same height and width as it had at design time.

poDefault

The form appears in a position on the screen and with a height and width determined by the operating system. Each time you run the application, the form moves slightly down and to the right. The right side of the form is always near the rightmost side of the screen, and the bottom of the form is always near the bottom of the screen, regardless of the screen’s resolution. The operating system only supports this for overlapped windows. For a pop-up or child window (that has a BorderStyle of bsDialog or bsNone, for example), the window is positioned in the upper-left corner of the screen.

poDefaultPosOnly

The form displays with the size you created it at design time, but the operating system chooses its position on the screen. Each time you run the application, the form moves slightly down and to the right. When the form can no longer move down and to the right and keep the same size while remaining entirely visible on the screen, the form displays at the upper-left corner of the screen. The operating system only supports this for overlapped windows. For a pop-up or child window (that has a BorderStyle of bsDialog or bsNone, for example), the window is positioned in the upper-left corner of the screen.

poDefaultSizeOnly

The form appears in the position you left it at design time, but the operating system chooses its size. The right side of the form is always near the rightmost side of the screen, and the bottom of the form is always near the bottom of the screen, regardless of the screen’s resolution.

poScreenCenter

The form remains the size you left it at design time, but is positioned in the center of the screen. In multi-monitor applications, the form may be moved from this center position so that it falls entirely on one monitor, as specified by the DefaultMonitor property.

poDesktopCenter

The form remains the size you left it at design time, but is positioned in the center of the screen. No adjustments are made for multi-monitor applications.

poMainFormCenter

The form remains the size you left it at design time, but is positioned in the center of the application’s main form. No adjustments are made for multi-monitor applications. This position should only be used with secondary forms. If set for a main form, it acts like poScreenCenter.

poOwnerFormCenter

The form remains the size you left it at design time, but is positioned in the center of the form specified by the Owner property. If the Owner property does not specify a form, this position acts like poMainFormCenter.

Note that if Position is set to poDefault, poDefaultPosOnly or poDefaultSizeOnly, and BorderStyle is set to bsDialog or bsNone, the form will be positioned at (0,0).

Previous()#: Activates the previous MDI child form in the form sequence. Use Previous to change the active child form of an MDI parent. For example, if you have three child forms within a parent form and Form4 is the active form, the Previous method makes Form3 the active form. Calling Previous again makes Form2 active. The next time your application calls Previous, the sequence starts over again and Form4 becomes the active form once again. The Previous method applies only to forms that are MDI parent forms (have a FormStyle property value of fsMDIForm).

PrintScale#

Represents the proportions of a printed form. Use PrintScale to get or set the proportions of the printed form. PrintScale can have one of the following TPrintScale values:

Value

Meaning

poNone

No special scaling occurs; therefore, the printed form and how the form appears onscreen may appear squished or stretched.

poProportional

The form is printed so that the printed image is approximately the same visible size as on the screen (WYSIWYG). The form image is scaled so that the printed image is approximately the same visible size as on the screen.

poPrintToFit

The form is printed using the same screen proportions, but in a size that just fits the printed page.

Release()#: Releases (destroys) the wrapped Form

Scaled#: Specifies whether the form is sized according to the value of the PixelsPerInch property. Scaled determines whether the form adjusts itself to differences between the font used at design time and the current system font used by a system at runtime. If Scaled is true, the form resizes itself and all its child controls to maintain the relationship between the size of controls and the height of text displayed in the default font. If Scaled is false, no such resizing occurs. By setting Scaled to true, the form can adjust to fonts that are not scalable (that is, fonts that only supply discrete point sizes) or to differences such as forms designed using small fonts at design time that are run on systems that use large fonts. The degree of resizing is determined by the PixelsPerInch property, which measures the proportion of the font on the system used when designing the form.

ScreenSnap#: Specifies whether form snaps to edge of screen. ScreenSnap determines whether the edges of the form snap to the edge of the screen when the user moves the form. To control the snap distance, set the SnapBuffer property.

ShowHint#

ShowHint specifies whether to show the Help Hint when the mouse pointer moves over the control. ShowHint determines whether the Help Hint appears for the control. The Help Hint is the value of the TControl.Hint property. The Help Hint appears in a box just beneath the control when the mouse pointer moves over the control. To enable Help Hints for a particular control, two conditions must be satisfied:

The application’s ShowHint property must be True. Either the control’s own ShowHint property must be True, or the control’s ParentShowHint property must be True and its parent’s ShowHint property must be True. For example, imagine a check box within a group box. If the ShowHint property of the group box is True and the ParentShowHint property of the check box is True, but the ShowHint property of the check box is False, the check box still displays its Help Hint. Changing the ShowHint value automatically sets the ParentShowHint property to False.

ShowModal()#: Shows the wrapped Form as a modal form

SnapBuffer#: Specifies distance for screen snap. If ScreenSnap is true, SnapBuffer determines the maximum number of pixels that be between the form edge and the screen edge before the form snaps to the screen edge.

StyleElements#: Specifies the style elements that are used by the control. Use StyleElements to customize the style of the control. If a custom style is enabled, you can enable or disable style elements in the control. StyleElements is a set of values that specify which elements of the current style are to be applied to this control. By default, all the elements of the style are enabled.

StyleName#: Embarcadero Technologies does not currently have any additional information.

Tile()#: Arranges MDI child forms so that they are all the same size. Use Tile to arrange MDI child forms so that they are all the same size. Tiled forms completely fill up the client area of the parent form. How the forms arrange themselves depends upon the values of their TileMode properties. Tile works only if the form is an MDI parent form (that is, if the form’s FormStyle property is fsMDIForm).

TileMode#

Represents how MDI child forms are arranged when the Tile method is called. TileMode can have one of the following TTileMode values:

Value

Meaning

tbHorizontal

Each form stretches across the width of the parent form

tbVertical

Each form stretches along the height of the parent form

TileMode is meaningful only if the form is an MDI child (that is, if the form’s FormStyle property is set to fsMDIChild).

TipMode#

TipMode indicates whether TabTip (onscreen keyboard equivalent) opens or closes when the control receives focus or if it receives a gesture. For example, in controls derived from TButtonControl the default mode is tipClose, so TabTip is instructed to disappear when the control receives focus or a gesture. The default for controls derived from TCustomEdit is tipOpen.

Note: The above applies only to devices that have touch screen support

Touch#

Specifies the touch manager component associated with the control. Use the Touch property to access gesturing options associated with a control. Touch specifies a class of type TTouchManager. Touch is used to:

Associate a TGestureManager. (TGestureManager manages all the gestures that can be used by the control.) Select the standard, interactive, or custom gestures to associate with the control. (You can also connect each gesture to an action; see Assigning Actions to Gestures.) Specify a set of options for interactive or tablet gestures.

TransparentColor#

Specifies whether a color on the form appears transparent. Use TransparentColor to indicate that one of the colors on the form should be treated as transparent, allowing windows behind the form to completely show through. The TransparentColorValue property indicates the color that appears completely transparent.

Note: To make the entire form transparent, or to make it translucent rather than transparent, use the AlphaBlend and AlphaBlendValue properties. Note: TransparentColor does not work on all systems. The application must be running under Windows 2000 or better, with adequate hardware.

TransparentColorValue#

Indicates the color on the form that appears transparent when TransparentColor is true. Use TransparentColorValue to indicate the color that appears transparent when the TransparentColor property is true.

Note: If the application uses a 16-bit color palette, TransparentColorValue must be a basic color.

UseDockManager#: Specifies whether the docking manager is used in drag-and-dock operations. Use UseDockManager to get or set whether a docking manager is used in drag-and-dock operations. The docking manager handles the positioning of docked controls and any painting of docking zones around those controls. If you do not use a docking manager, docked controls are aligned to the windowed control based on the closest edge to where they are released. When you do not use a docking manager, there is no region for a user to grab to automatically undock a docked control.

VertScrollBar#: Represents the vertical scroll bar for the scrolling windowed control. Use VertScrollBar to hide, show, or manipulate the vertical scroll bar for the scrolling windowed 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. Calling the Show method sets the control’s Visible property to True. Calling the Hide method sets it to False. For TCustomForm descendants, the Show and ShowModal methods set Visible to True and bring the form to the front of all open windows. For TTabSheet descendants, Visible does not control the visibility of the control at run time. For more information, see the description of the TabVisible property.

Width#

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

Note: For tab sheet controls, changing this property at run time has no effect.

WindowMenu#: Specifies the Window menu for an MDI parent form. Use WindowMenu to get or set the Window menu for an MDI parent form. The Window menu is a standard menu in MDI applications. It contains commands that let the user manage the windows in the application. Menu items usually include Cascade, Arrange Icons, Tile, and so on. The Window menu also lists (at the bottom) the child windows that are currently open in the application. When the user selects one of these windows from the menu, the window becomes the active window in the application. Although this menu is commonly called the Window menu, it can have any name that corresponds to an existing menu item on the menu bar. The names of open child forms are merged onto the menu automatically at run-time. WindowMenu is meaningful only if the form is an MDI parent (that is, if the form’s FormStyle property is set to fsMDIForm).

WindowState#: Represents how the form appears on the screen. Set WindowState to minimize, maximize, or restore the form window. Read WindowState to determine whether the form is minimized, maximized, or in a normal state.

get_MDIChildren(I: Integer) → Form#: Embarcadero Technologies does not currently have any additional information.