[Properties (by Name)] [Methods (by Name)] [Events (by Name)]
Frames can be designed like Forms and used like custom controls, without much coding or installation in the IDE.
Source position: forms.pp line 326
type TFrame = class(TCustomFrame) |
||
public |
||
constructor Create(); override; |
|
Constructor for the class instance. |
published |
||
|
Specifies the placement of the control on its Parent control. |
|
|
The set of anchor definitions for this control. |
|
property AutoScroll: Boolean; |
|
Indicates whether scroll bars are automatically displayed or hidden when needed. |
property AutoSize: Boolean; |
|
Allows automatic adjustment of the size for the control, according to its content. |
property BiDiMode: TBiDiMode; |
|
Customization (of text controls) in bidirectional reading environments. |
property BorderSpacing: TControlBorderSpacing; |
|
Determines the inner and outer border spacing for this control. |
property ChildSizing: TControlChildSizing; |
|
Parameters for child control arrangement and spacing. |
property ClientHeight: Integer; |
|
The height for the client area on the control. |
property ClientWidth: Integer; |
|
The width of the client area for the control. |
property Color: TGraphicsColor; |
|
The background color of the control. |
property Constraints: TSizeConstraints; |
|
Contains the minimum and maximum Width and Height for the control. |
property DesignTimePPI: Integer; |
|
Design-time Pixels Per Inch for the designer surface. |
property DockSite: Boolean; |
|
Allows controls to be drag-dock'd into this control. |
property DragCursor: TCursor; |
|
The cursor shape shown while the control is dragged. |
|
The operation when the control is dragged - Drag or Dock. |
|
|
Allows the user to drag the control. |
|
property Enabled: Boolean; |
|
Determines whether the control reacts on mouse or keyboard input. |
|
The font to be used for text display in this control. |
|
property LCLVersion: string; [rws] |
|
LCL version number for the frame instance. |
property OnClick: TNotifyEvent; |
|
Notification handler for mouse clicks. |
property OnConstrainedResize: TConstrainedResizeEvent; |
|
This handler can supply specific Constraints (size limits), when the control is resized. |
property OnContextPopup: TContextPopupEvent; |
|
Invoked when a context-sensitive pop-up menu is requested. |
property OnDblClick: TNotifyEvent; |
|
Event Handler for double mouse clicks. |
property OnDockDrop: TDockDropEvent; |
|
Notification handler for the drop of a control to be docked. |
property OnDockOver: TDockOverEvent; |
|
Event handler for moves of a control over this docksite; determines acceptance or rejection of an possible drop. |
property OnDragDrop: TDragDropEvent; |
|
This handler determines the action on an drop onto this control, in a drag-drop operation. |
property OnDragOver: TDragOverEvent; |
|
Event handler for a control being dragged over this control. |
property OnEndDock: TEndDragEvent; |
|
Notification handler for the end of a docking operation. |
property OnEndDrag: TEndDragEvent; |
|
Notification handler for the end of a drag operation. |
property OnEnter: TNotifyEvent; |
|
Handler for control receiving the focus. |
property OnExit: TNotifyEvent; |
|
Handler for control loosing the focus; This is a good place for checking the finished user input. |
property OnGetSiteInfo: TGetSiteInfoEvent; |
|
Provides information about the DockSite for the control. |
property OnMouseDown: TMouseEvent; |
|
Event handler signalled when a mouse down event is handled for the control. |
property OnMouseEnter: TNotifyEvent; |
|
Event handler signalled when the mouse pointer has entered the control. |
property OnMouseLeave: TNotifyEvent; |
|
Event handler signalled when the mouse pointer has left the control. |
property OnMouseMove: TMouseMoveEvent; |
|
Event handler for mouse movement within the control. |
property OnMouseUp: TMouseEvent; |
|
Event handler signalled when a mouse up event is handled for the control. |
property OnMouseWheel: TMouseWheelEvent; |
|
Event handler for mouse wheel turned. |
property OnMouseWheelDown: TMouseWheelUpDownEvent; |
|
Event handler for downward movement of mouse wheel. |
property OnMouseWheelUp: TMouseWheelUpDownEvent; |
|
Event handler for upward movement of the mouse wheel. |
property OnMouseWheelHorz: TMouseWheelEvent; |
|
Event handler for horizontal movements of the mouse wheel. |
property OnMouseWheelLeft: TMouseWheelUpDownEvent; |
|
Event handler for left movements of the mouse wheel. |
property OnMouseWheelRight: TMouseWheelUpDownEvent; |
|
Event handler for right movements of the mouse wheel. |
property OnResize: TNotifyEvent; |
|
Notification handler for a resize of the control. |
property OnStartDock: TStartDockEvent; |
|
Event handler for the start of a docking operation. |
property OnStartDrag: TStartDragEvent; |
|
Event handler for the start of a dragging operation. |
property OnUnDock: TUnDockEvent; |
|
Event handler signalled before a control is undocked from its DockSite. |
property ParentBackground: Boolean; |
|
Indicates if the control uses the background from the parent. |
property ParentBiDiMode: Boolean; |
|
Indicates whether the BiDiMode settings in the Parent control are used. |
property ParentColor: Boolean; |
|
Use the Color from the Parent control, when enabled. |
property ParentFont: Boolean; |
|
If True, the Font of the control will be the same as the one from the Parent. Default is True. |
property ParentShowHint: Boolean; |
|
If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True. |
property PopupMenu: TPopupMenu; |
|
A context-sensitive menu that pops up when the right mouse button is clicked over this control. |
property Scaled: Boolean; |
|
Indicates if the design surface is scaled to reflect changes in display density (Pixels Per Inch). |
property ShowHint: Boolean; |
|
Enables Hint display for the control. |
|
Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key. |
|
property TabStop: Boolean; |
|
Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys. |
property Visible: Boolean; |
|
Allows the control, and all of its children, to be displayed or hidden. |
end; |
|
Frames can be designed like Forms and used like custom controls, without much coding or installation in the IDE. |
|
| | ||
|
The base type for TFrame. |
|
| | ||
|
Provides a designer surface for scaling and layout of its child controls. |
|
| | ||
|
Class of a windowed control with incorporated scroll bars. |
|
| | ||
|
The base class for windowed controls which paint themselves. |
|
| | ||
|
Implements a windowed control which can contain other child controls. |
|
| | ||
|
The base class for visible controls. |
|
| | ||
|
The base class for LCL components which have an associated widget. |
|
| | ||
TObject |
TFrame is a TCustomFrame descendant which implements a named container for related components. Groups of controls can be place on a frame, and re-used in your applications.
A Frame has behavior very similar to a Form. Their unique ability is that they can be embedded into forms or other frames in the designer. Like forms, they are stored in two separate files: the code is stored in a .pas unit file, and the design is stored in a .lfm file.
Frames can be created and designed in the Lazarus IDE by creating a new Frame module, and using the unit in your application. An existing frame can be added using the TFrame component on the Standard tab in the Lazarus IDE; you will be prompted for the TFrame class to use for the component.
Frames can also be created entirely in code at run-time. They do not have to be installed in the Lazarus IDE. One drawback is that complex inheritance hierarchies for TFrame classes can be problematic; they do not propagate changes to all derived frames in the entire inheritance tree.
TFrame contains a new property which indicates the LCL (Lazarus Component Library) version number used in the container. An overridden constructor is also introduced to initialize the value in the LCLVersion property. TFrame sets the visibility for properties defines in ancestor classes.