[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'Forms' (#lcl)

TForm

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Form - the fundamental visual object that appears in every application with a Graphical User Interface.

Declaration

Source position: forms.pp line 628

type TForm = class(TCustomForm)

protected

  procedure CreateWnd; override;

  

CreateWnd - performs inherited CreateWnd then updates ScrollBars

  procedure Loaded; override;

  

Loaded - calls inherited Loaded, makes this the active control and gives it focus

public

  constructor Create(); override;

  

Create - constructor for TCustomForm: checks for correct ClassType, looks for required resources then creates the Form

  property ClientHandle: HWND; [r]

  

The operating system handle for the client

  property DockManager;

  

Property that actually controls the docking process

published

  property Action;

  

The action to be associated with this control

  property ActiveControl;

  

Specifies the active control on the form

  property Align;

  

Used to align the control to the top, bottom, left or right of its client.

  property AllowDropFiles;

  

Specifies if files are allowed to be dropped on this form.

  property AutoScroll;

  

Does auto-scrolling apply?

  property AutoSize;

  

Whether auto-size is to be used

  property BiDiMode;

  

BiDiMode - enabling bi-directional writing

  property BorderIcons;

  

Specifies which icons appear on the top of the form

  property BorderStyle;

  

The border style for this Form

  property BorderWidth;

  property Caption;

  

Caption - the text-string appearing on the Control, usually used to identify its function

  property ChildSizing;

  

Definitions of how any child control is to be sized

  property ClientHeight;

  

ClientHeight - determines the height of the client within which the control exists

  property ClientWidth;

  

ClientWidth - determines the width of the client within which the control exists

  property Color;

  

Determine the colour for the current control

  property Constraints;

  

Determine Constraints (max and min height and width) for this control

  property DefaultMonitor;

  property DockSite;

  

Is this a dock site? Default false

  property DragKind;

  

DragKind - what sort of dragging? Drag or Dock

  property DragMode;

  

DragMode - whether manual or automatic

  property Enabled;

  

Whether the control is Enabled. If not, it usually appears 'greyed-out'

  property Font;

  

The Font to be used for text in this control

  property FormStyle;

  

Determinates the style of the form

  property HelpFile;

  

Specifies the help file that is used by the form

  property Icon;

  

The Icon associated with this Form (which may appear in menus, directories, ListBoxes etc)

  property KeyPreview;

  

KeyPreview - if True, Key Preview is possible

  property Menu;

  

Specifies a MainMenu for this form

  property OnActivate;

  

Event handler for activation (opening) of the form

  property OnChangeBounds;

  

Event handler for a change in bounds of the control

  property OnClick;

  

Event Handler for mouse click

  property OnClose;

  

Event handler for closing the form

  property OnCloseQuery;

  

Event handler for closing the query associated with the form

  property OnCreate;

  

Event handler for creating the form

  property OnDblClick;

  

Event Handle for mouse double-click

  property OnDeactivate;

  

Event handler for deactivating the form

  property OnDestroy;

  

Event handler when the form is being destroyed

  property OnDockDrop;

  

Event handler for dropping a control in a docked position

  property OnDockOver;

  

Event handler for docking a control over another control

  property OnDragDrop;

  

Event handler for the Drag-Drop manoeuvre

  property OnDragOver;

  

Event handler for the case when a control is dragged over another control

  property OnDropFiles;

  

The event invoked when file is dropped on this form.

  property OnEndDock;

  

Event handler for the end of a docking manoeuvre

  property OnGetSiteInfo;

  

OnGetSiteInfo - event handler for finding out information about the (docking) site

  property OnHelp;

  

Event handler when Help is required

  property OnHide;

  

Event handler if form is being hidden

  property OnKeyDown;

  

OnKeyDown - event handler for instance when key is down while control has focus

  property OnKeyPress;

  

OnKeyPress - event controller for a key being pressed while the control has focus. To properly handle national chars use UTF8KeyPress instead.

  property OnKeyUp;

  

OnKeyUp - event handler for instance when a key is up (not pressed) while the control has focus

  property OnMouseDown;

  

Event handler for when a mouse button is pressed down

  property OnMouseMove;

  

Event handler for mouse movement within the current control

  property OnMouseUp;

  

Event handler for when the mouse button is released, ie "up"

  property OnMouseWheel;

  

OnMouseWheel - event handler for a movement of the mouse wheel

  property OnMouseWheelDown;

  

OnMouseWheelDown - event handler for downward movement of mouse wheel

  property OnMouseWheelUp;

  

OnMouseWheelUp - event handler for upward movement of mouse wheel

  property OnPaint;

  

Event handler for painting

  property OnResize;

  

Event Handler for resize of control

  property OnShortCut;

  

Event handler if shortcut key is pressed

  property OnShow;

  

Event handler if form is to be shown

  property OnShowHint;

  

Event Handler when a hint needs to be shown

  property OnStartDock;

  

Event handler for the start of a docking manoeuvre

  property OnUnDock;

  

OnUnDock - event handler for control becoming disconnected (undocked) from parent

  property OnUTF8KeyPress;

  

UTF8KeyPress - event controller for a key being pressed while the control has focus.

  property OnWindowStateChange;

  

Event handler for a change in the window state

  property ParentBiDiMode;

  

ParentBiDiMode - does the control follow the BiDiMode settings of its parent?

  property ParentFont;

  

ParentFont - should the control use the same font as the parent? Default is true

  property PixelsPerInch;

  

The scaling of the form in absolute terms

  property PopupMenu;

  

PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control

  property Position;

  

The position of the form on the screen

  property SessionProperties;

  

The stored (saved) properties of the current session, expressed as a string

  property ShowHint;

  

Flag to determine: Is hint to be displayed for this control?

  property ShowInTaskBar;

  

Should the form be shown in the system Task Bar?

  property UseDockManager;

  

Use a dock manager to control docking? (default false)

  property LCLVersion: String; [rws]

  

The version of the LCL as string. Used to distinguish form streams of different versions.

  property Visible;

  

Visible - can the control be seen?

  property WindowState;

  

Represents how the form appears on the screen

end;

Inheritance

TForm

  

Form - the fundamental visual object that appears in every application with a Graphical User Interface.

|

TCustomForm

  

TCustomForm - the base type for TForm

|

TScrollingWinControl

  

TScrollingWinControl - a class of Window Control that has one or more scroll bars

|

TCustomControl

  

TCustomControl - a base class for many window controls

|

TWinControl

  

TWinControl - the base class for all windowed controls

|

TControl

  

TControl - the main ancestor class for visual controls.

|

TLCLComponent

?

TObject

Description

Form - the fundamental visual object that appears in every GUI application.

Most of the properties are inherited from the ancestors

See also

TCustomForm

  

TCustomForm - the base type for TForm

TScrollingWinControl

  

TScrollingWinControl - a class of Window Control that has one or more scroll bars

TCustomControl

  

TCustomControl - a base class for many window controls

#lcl.Controls.TWinControl

  

TWinControl - the base class for all windowed controls

#lcl.Controls.TControl

  

TControl - the main ancestor class for visual controls.

The latest version of this document can be found at lazarus-ccr.sourceforge.net.