CustomForm¶

Qualified name: delphifmx.CustomForm

class CustomForm¶

Bases: CommonCustomForm

TCustomForm represents the base class from which you derive other windows such as dialog boxes and forms. Create a subclass derived from TCustomForm if you want to create new forms such as dialog boxes. A derived form can contain one or more FireMonkey objects, such as TLabel, TComboBox, and so on. Note that every descendant of TCustomForm is a 2D FireMonkey form or dialog box.

Methods

`EndUpdate`	Ends updating all the child controls in this form.
`InitializeNewForm`	Performs several initializations required by this form.
`LoadProps`	TCommonCustomForm.LoadProps() Load properties from a .pydfm file
`PaintTo`	TCustomForm.PaintTo(Canvas: Canvas) -> None Embarcadero Technologies does not currently have any additional information.
`RecreateResources`	Recreates the canvas where the form renders itself.

Attributes

`Action`	Specifies the action associated with the control.
`ActionClient`	Specifies whether the component object has an associated action.
`Active`	Specifies whether the form has focus.
`ActiveControl`	Specifies the active control on the form.
`BiDiMode`	Indicates the layout of this form when running under Middle Eastern versions of the operating system.
`Border`	Embarcadero Technologies does not currently have any additional information.
`BorderIcons`	Specifies which icons appear on the title bar of the form.
`BorderStyle`	Specifies the appearance and behavior of the form border.
`Bounds`	Bounds of form - position and size.
`BoundsF`	Embarcadero Technologies does not currently have any additional information.
`Canvas`	Provides access to the drawing area of the form.
`Caption`	Specifies a text string that identifies the form to the user.
`Captured`	Specifies the control that has captured the mouse.
`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.
`ClassName`	Returns the TObject.ClassName
`ClientHeight`	Specifies the height (in pixels) of the form's client area.
`ClientWidth`	Specifies the width (in pixels) of the form's client area.
`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
`Constraints`	Embarcadero Technologies does not currently have any additional information.
`Cursor`	Specifies the mouse cursor that will be used on this form.
`Data`	Stores a Tvalue, which is a data structure that can store different kinds of data types.
`DesignInfo`	Contains information used by the Form designer.
`Designer`	Specifies the designer interface for the form.
`Fill`	Specifies the way the background on this form is filled.
`Focused`	Specifies the control that has the focus set on it.
`FormFactor`	width, height, orientations, and devices.
`FormFamily`	Is a string property that specifies the form family this form is part of.
`FormState`	Indicates transitional state information about the form.
`FormStyle`	Determines the form style.
`FullScreen`	Indicates whether the form is in fullscreen mode.
`Handle`	Specifies the handle of this form.
`Height`	Specifies the vertical size of the form (in pixels).
`Hovered`	Identifies the control over which the mouse pointer is hovering.
`Index`	Specifies the index of the child object in the children array attached to this object.
`Left`	Specifies the X coordinate of the upper-left corner of the form, relative to the screen.
`ModalResult`	Represents the return value of a form that is used as a modal dialog box.
`Name`	Specifies the name of the component as referenced in code.
`Observers`	Indicates the TObservers object added to the TComponent.
`OriginalContainerSize`	Embarcadero Technologies does not currently have any additional information.
`Owner`	Returns the Component Owner
`Padding`	Specifies the padding of the form.
`Parent`	Returns/Sets the Control Visibility
`ParentForm`	Specifies the parent form of this form.
`Position`	Represents the size and placement of the form.
`Quality`	Embarcadero Technologies does not currently have any additional information.
`Root`	Specifies the root parent of this object.
`SaveState`	Specifies the save state of the FireMonkey form.
`ShowFullScreenIcon`	Indicates whether the Mac fullscreen icon is visible.
`ShowHint`	Determines whether help hints are enabled or disabled for first level child controls in the form. For more information about the rules for enabling hints for a control, see Using Hints to Show Contextual Help in a FireMonkey Application. TCommonCustomForm.ShowHint is a Boolean property set as True by default. When you place a child control in the form, and set the TControl.Hint property, the hint is displayed because the TControl.ParentShowHint is True by default. If the TCommonCustomForm.ShowHint property of the form is set to False, the hint is not displayed in the child control. To show the hint for a control, even when the TCommonCustomForm.ShowHint property of the form is set to False, set TControl.ShowHint for the control to True.
`Stored`	Specifies whether this object is stored in the .XFM file.
`StyleBook`	Specifies the style book for this form.
`StyleLookup`	Specifies the name of the style to look up and apply to this form.
`StyleName`	Specifies the style name for this FMX component.
`SystemStatusBar`	System status bar settings on mobile platforms.
`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.
`Top`	Specifies the Y coordinate of the upper-left corner of the form, relative to the screen.
`Touch`	Embarcadero Technologies does not currently have any additional information.
`Transparency`	Indicates whether the form is transparent or not.
`VCLComObject`	Represents information used internally by components that support COM.
`Visible`	Indicates whether the form is visible.
`Width`	Specifies the horizontal size of the form (in pixels).
`WindowState`	Represents how the form appears on the screen.
`WindowStyle`	Embarcadero Technologies does not currently have any additional information.

Action¶

Specifies the action associated with the control. Action allows an application to centralize the response to user commands. When a control is associated with an action, the action determines the appropriate properties and events of the control (such as whether the control is enabled or how it responds to an OnClick event). If an object of the descendant from the TFmxObject class does not support actions, and when this object tries to assign a value to the Action property, the setter method for Action calls GetActionLinkClass that should return nil. In this case, attempting to set a value to the Action property raises the following exception:

StrEActionNoSuported = ‘Class %s does not support the action’

Type:: BasicAction

ActiveControl¶

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

Type:: Control

Canvas¶

Provides access to the drawing area of the form. Use Canvas to draw directly on the client area of the form.

Type:: Canvas

EndUpdate()¶: Ends updating all the child controls in this form. FMX.Forms.TCustomForm.EndUpdate inherits from FMX.Forms.TCommonCustomForm.EndUpdate. All content below this line refers to FMX.Forms.TCommonCustomForm.EndUpdate. Ends updating all the child controls in this form. EndUpdate ends updating all the child controls placed on this form, finalizing any updates you might have performed on the form or on multiple children. EndUpdate signals the end of an update operation and must be preceded by BeginUpdate and by the updates themselves.

Fill¶

Specifies the way the background on this form is filled. Use Fill to get or set the brush that defines the way the background of this form is painted (gradient, solid, and so on).

Tip: Using a brush for Fill overrides the functionality of the Transparency property.

Type:: Brush

InitializeNewForm()¶: Performs several initializations required by this form. FMX.Forms.TCustomForm.InitializeNewForm inherits from FMX.Forms.TCommonCustomForm.InitializeNewForm. All content below this line refers to FMX.Forms.TCommonCustomForm.InitializeNewForm. Performs several initializations required by this form. These initializations include bounds, width and height, border icons, border style, and client size for the form. InitializeNewForm is used by the form constructors.

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

PaintTo(Canvas: Canvas) → None¶: Embarcadero Technologies does not currently have any additional information.

Parent¶: Returns/Sets the Control Visibility

Quality¶

Embarcadero Technologies does not currently have any additional information.

Type:: CanvasQuality

RecreateResources()¶: Recreates the canvas where the form renders itself.

StyleLookup¶

Specifies the name of the style to look up and apply to this form. The FireMonkey Component Design help topic shows, among other useful things related to component designing, how to apply a style to a TPanel component.

Type:: str