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

TCustomForm

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

TCustomForm - the base type for TForm

Declaration

Source position: forms.pp line 372

type TCustomForm = class(TScrollingWinControl)

protected

  FFormBorderStyle: TFormBorderStyle;

  

  FActionLists: TList;

  

  procedure CMShowingChanged(); message;

  

  procedure Activate; dynamic;

  

  procedure ActiveChanged; dynamic;

  

  procedure BeginFormUpdate;

  

  procedure CreateParams(); override;

  

  procedure CreateWnd; override;

  

  procedure Deactivate; dynamic;

  

  procedure DestroyWnd; override;

  

  procedure DoClose(); dynamic;

  

  procedure DoCreate; virtual;

  

  procedure DoDestroy; virtual;

  

  procedure DoHide; dynamic;

  

  procedure DoShow; dynamic;

  

  procedure EndFormUpdate;

  

  procedure GetChildren(); override;

  

  procedure Loaded; override;

  

  procedure ChildHandlesCreated; override;

  

  procedure Notification(); override;

  

  procedure PaintWindow(); override;

  

  procedure RequestAlign; override;

  

  procedure SetZOrder(); override;

  

  procedure SetParent(); override;

  

  procedure UpdateShowing; override;

  

  procedure SetVisible(); override;

  

  procedure DoFirstShow; virtual;

  

  procedure UpdateWindowState;

  

  procedure VisibleChanging; override;

  

  procedure WndProc(); override;

  

  function FormIsUpdating; override;

  

  function VisibleIsStored;

  

  function ColorIsStored; override;

  

  procedure DoSendBoundsToInterface; override;

  

  procedure DoAutoSize; override;

  

  procedure SetAutoSize(); override;

  

  function GetControlClassDefaultSize; override;

  

  procedure DoDock(); override;

  

  function GetFloating; override;

  

  function GetDefaultDockCaption; override;

  

  procedure CMActionExecute(); message;

  

  procedure CMActionUpdate(); message;

  

  function DoExecuteAction();

  

Asks every visible control to Execute the specified action ExeAction.

  function DoUpdateAction();

  

  procedure UpdateActions; virtual;

  

public

  constructor Create(); override;

  

  constructor CreateNew(); virtual;

  

  procedure BeforeDestruction; override;

  

  function GetIconHandle;

  

Find the handle for the Icon

  destructor Destroy; override;

  

  procedure Close;

  

Close the form and release its resources

  function CloseQuery; virtual;

  

Is the associated query to be closed?

  procedure Release;

  

Set free the resources of the form

  procedure Hide;

  

  procedure Show;

  

Shows, brings to front and activates the form

  procedure ShowOnTop;

  

Shows this form as the top (nearest) item of any stack of windows or images.

  procedure EnsureVisible();

  

Ensure that this form is always visible, if necessary moving it to the top (front) of the stack of images

  function NeedParentForAutoSize; override;

  

  function WantChildKey(); virtual;

  

  procedure DefocusControl();

  

  procedure SetFocus; override;

  

  function SetFocusedControl(); virtual;

  

  procedure FocusControl();

  

  function ShowModal; virtual;

  

Show this form as modal - ie control cannot be resumed by another form until the current form is closed

  procedure SetRestoredBounds();

  

  function GetRolesForControl();

  

  procedure RemoveAllHandlersOfObject(); override;

  

  procedure AddHandlerFirstShow();

  

  procedure RemoveHandlerFirstShow();

  

  procedure AddHandlerClose();

  

  procedure RemoveHandlerClose();

  

  procedure AddHandlerCreate();

  

  procedure RemoveHandlerCreate();

  

  function IsShortcut(); virtual;

  

IsShortcut - if True, the specified Key and Message are active as a shortcut

  procedure IntfDropFiles();

  

  procedure IntfHelp();

  

  function GetFormImage;

  procedure Dock(); override;

  

  property Active: Boolean; [r]

  

Is true when the form has the focus

  property ActiveControl: TWinControl; [rw]

  

Specifies the active control on the form

  property ActiveDefaultControl: TControl; [rw]

  

Specifies the active default control on the Form

  property AllowDropFiles: Boolean; [rw]

  

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

  property BorderIcons: TBorderIcons; [rw]

  

Specifies which icons appear on the top of the form

  property BorderStyle: TFormBorderStyle; [rw]

  

The border style for this Form

  property CancelControl: TControl; [rw]

  

The control associated with the cancel action

  property Caption; [s]

  

  property Color;

  

The form's colour; by default it is the same as the colour specified for button faces.

  property DefaultControl: TControl; [rw]

  

The control associated with the default action for this form

  property Designer: TIDesigner; [rw]

  

  property FormState: TFormState; [r]

  

Determines the state of the form

  property FormStyle: TFormStyle; [rw]

  

Determinates the style of the form

  property HelpFile: String; [rws]

  

Specifies the help file that is used by the form

  property Icon: TIcon; [rws]

  

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

  property KeyPreview: Boolean; [rws]

  

  property Menu: TMainMenu; [rw]

  

Specifies a MainMenu for this form

  property ModalResult: TModalResult; [rw]

  

Specifies the return value of an modal form

  property OnActivate: TNotifyEvent; [rw]

  

Event handler for activation (opening) of the form

  property OnClose: TCloseEvent; [rws]

  

Event handler for closing the form

  property OnCloseQuery: TCloseQueryEvent; [rws]

  

Event handler for closing the query associated with the form

  property OnCreate: TNotifyEvent; [rw]

  

Event handler for creating the form

  property OnDeactivate: TNotifyEvent; [rw]

  

Event handler for deactivating the form

  property OnDestroy: TNotifyEvent; [rw]

  

Event handler when the form is being destroyed

  property OnDropFiles: TDropFilesEvent; [rw]

  

The event invoked when file is dropped on this form.

  property OnHelp: THelpEvent; [rw]

  

Event handler when Help is required

  property OnHide: TNotifyEvent; [rw]

  

Event handler if form is being hidden

  property OnResize; [s]

  

  property OnShortcut: TShortCutEvent; [rw]

  

Event handler if shortcut key is pressed

  property OnShow: TNotifyEvent; [rw]

  

Event handler if form is to be shown

  property OnWindowStateChange: TNotifyEvent; [rw]

  

Event handler for a change in the window state

  property PixelsPerInch: LongInt; [rws]

  

The scaling of the form in absolute terms

  property Position: TPosition; [rw]

  

The position of the form on the screen

  property RestoredLeft: Integer; [r]

  

The position of the left edge of the form when it is restored (ie changes from minimised or maximised)

  property RestoredTop: Integer; [r]

  

The position of the top edge of the form when it is restored (ie changes from minimised or maximised)

  property RestoredWidth: Integer; [r]

  

The width of the form when it is restored (ie changes from minimised or maximised)

  property RestoredHeight: Integer; [r]

  

The height of the form when it is restored (ie changes from minimised or maximised)

  property ShowInTaskBar: TShowInTaskbar; [rw]

  

Should the form be shown in the system Task Bar?

  property Visible; [s]

  

Indicates if the form is visible

  property WindowState: TWindowState; [rw]

  

Represents how the form appears on the screen

end;

Inheritance

TCustomForm

  

TCustomForm - the base type for TForm

|

TScrollingWinControl

  

Scrolling Window Control

|

TCustomControl

  

TCustomControl - a base class for many window controls

|

TWinControl

  

The base class for all windowed controls

|

TControl

  

TControl - the main ancestor class for visual controls.

|

TLCLComponent

?

TObject

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