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

TCustomForm

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

The base type for TForm.

Declaration

Source position: forms.pp line 436

type TCustomForm = class(TCustomDesignControl) end;

protected

  procedure WMActivate(); message;

  

  procedure WMCloseQuery(); message;

  

  procedure WMHelp(); message;

  

  procedure WMMove(); message;

  procedure WMShowWindow(); message;

  

  procedure WMSize(); message;

  

  procedure WMWindowPosChanged(); message;

  

  procedure CMBiDiModeChanged(); message;

  

  procedure CMParentBiDiModeChanged(); message;

  

  procedure CMAppShowBtnGlyphChanged(); message;

  

  procedure CMAppShowMenuGlyphChanged(); message;

  

  procedure CMIconChanged(); message;

  

  procedure CMRelease(); message;

  

  procedure CMActivate(); message;

  

  procedure CMDeactivate(); message;

  

  procedure CMShowingChanged(); message;

  

  procedure WMDPIChanged(); message;

  FActionLists: TList;

  

FActionLists - local variable holding lists of actions asociated with the Form

  FFormBorderStyle: TFormBorderStyle;

  FFormState: TFormState;

  class procedure WSRegisterClass; override;

  

Registers this component class with the current WidgetSet.

  procedure DoShowWindow; virtual;

  

When no control is Active, sets the Focus to the first control in TabOrder.

  procedure Activate; virtual;

  

Notifies the OnActivate handler.

  procedure ActiveChanged; virtual;

  

Does nothing.

  procedure AdjustClientRect(); override;

  

Excludes borders from the given rectangle.

  procedure BeginFormUpdate;

  

Locks form updates (AutoSize), until EndFormUpdate.

  function ColorIsStored; override;

  

The background color of the control.

  procedure CreateParams(); override;

  

Initializes the window creation parameter record with the settings of the control.

  procedure CreateWnd; override;

  

Creates the interface object (widget) and assigns it to Handle.

  procedure Deactivate; virtual;

  

Called when the form looses the focus. Notifies the OnDeactivate handler.

  procedure DoClose(); virtual;

  

Notifies the form close handlers.

  procedure DoCreate; virtual;

  

Notifies the form create handlers.

  procedure DoDestroy; virtual;

  

Notifies the OnDestroy handler.

  procedure DoHide; virtual;

  

Notifies the OnHide handler.

  procedure DoShow; virtual;

  

Notifies the OnShow handler.

  procedure EndFormUpdate;

  

Unlocks form updates, in sync with BeginFormUpdate.

  function HandleCreateException; virtual;

  

Placeholder for exception handlers in derived classes.

  function HandleDestroyException; virtual;

  

Placeholder for exception handlers in derived classes.

  function HandleShowHideException; virtual;

  

Placeholder for exception handlers in derived classes.

  procedure InitializeWnd; override;

  

Initializes the widget, also for AlphaBlend and AllowDropFiles.

  procedure Loaded; override;

  

Also renews ActiveControl and Visible.

  procedure ChildHandlesCreated; override;

  

Called after all child control handles are created. When this is a top level form (Parent=Nil) also invokes ParentFormHandleInitialized.

  procedure Notification(); override;

  procedure PaintWindow(); override;

  

The Paint handler plug-in, intercepting paint requests.

  procedure RequestAlign; override;

  

Smart calling of Parent.AlignControls (very indirectly).

  procedure Resizing(); override;

  procedure CalculatePreferredSize(); override;

  

Override this method to return the preferred height and width.

  procedure SetZOrder(); override;

  

Here: Moves a top-level form in front or back of all forms.

  procedure SetParent(); override;

  

The control within which the control is shown.

  procedure MoveToDefaultPosition; virtual;

  

Moves the form to the initial Position.

  procedure UpdateShowing; override;

  

Called when the widget's visibility (Showing) changed. Updates (and realizes?) all properties affecting the visual representation.

  procedure SetVisible(); override;

  procedure AllAutoSized; override;

  

Called by DoAllAutoSize after all bounds are computed.

  procedure DoFirstShow; virtual;

  

Notifies the FirstShow handlers.

  procedure UpdateWindowState;

  

  procedure VisibleChanging; override;

  

Notifies all VisibleChanging handlers.

  procedure VisibleChanged; override;

  

Notifies all VisibleChanged handlers.

  procedure WndProc(); override;

  

The general message handler for this control.

  function VisibleIsStored;

  procedure DoSendBoundsToInterface; override;

  

Sends the control's new bounds to the widget.

  procedure DoAutoSize; override;

  

For internal use only - call AdjustSize instead!

  procedure SetAutoSize(); override;

  

Allows to automatically adjust the size of the control, according to its content.

  procedure SetAutoScroll(); override;

  procedure SetScaled(); override;

  procedure DoAddActionList();

  

Adds another ActionList.

  procedure DoRemoveActionList();

  

Removes an ActionList.

  procedure ProcessResource; virtual;

  procedure BeginAutoDrag; override;

  

Checked BeginDrag.

  procedure DoDock(); override;

  

Internal method, called by Dock. Adjusts the control's position and extent for the new docksite.

  function GetFloating; override;

  

Guess whether the control is floating.

  function GetDefaultDockCaption; override;

  

Here: returns the Caption.

  procedure CMActionExecute(); message;

  

Handler for ActionExecute messages.

  procedure CMActionUpdate(); message;

  

Handler for ActionUpdate messages.

  function DoExecuteAction();

  

Asks all applicable components to execute an action.

  function DoUpdateAction();

  

Tries all applicable components to update an action.

  procedure UpdateActions; virtual;

  

Asks all components to initiate their actions

  property ClientHandle: HWND; [r]

  

The Handle of the MDIForm client (container for mdi children).

public

  constructor Create(); override;

  constructor CreateNew(); virtual;

  

Creates a form without a resource.

  destructor Destroy; override;

  procedure AfterConstruction; override;

  procedure BeforeDestruction; override;

  class function GetControlClassDefaultSize; override;

  

Returns the default size for this class of controls (when added to a form).

  function BigIconHandle;

  

The Handle of the big form icon.

  procedure Close;

  

Close the form.

  function CloseQuery; virtual;

  

Asks the OnCloseQuery handler whether the form can close.

  procedure DefocusControl();

  

Updates ActiveControl if it is to be defocused.

  procedure DestroyWnd; override;

  

Destroys the interface object (widget).

  procedure EnsureVisible();

  

Ensure that this form is fully visible, optionally brings it in front of all forms.

  procedure FocusControl();

  

Focus the control. If needed bring form to front.

  function FormIsUpdating; override;

  

True if the form is being updated

  function GetFormImage;

  

Makes a Bitmap image from the Form.

  function GetRolesForControl();

  

The role(s) of the control in a modal form (default or cancel button).

  function GetRealPopupParent;

  procedure Hide;

  

Hides this control, by setting Visible to False.

  procedure IntfDropFiles();

  

Invokes the OnDropFiles handler of the form. This function is called by the interface.

  procedure IntfHelp();

  

Show help for control or menu item. This function is called by the interface.

  function IsShortcut(); virtual;

  

Asks all applicable components to interpret an keystroke as an shortcut. True, the specified Key and Message are active as a shortcut

  procedure MakeFullyVisible();

  

Extends or shrinks the form to a monitor.

  function AutoSizeDelayedHandle; override;

  

Returns true if AutoSize should be skipped / delayed because of a missing handle.

  procedure GetPreferredSize(); override;

  

Returns default/preferred height and width, for use in autosizing.

  procedure Release;

  

Marks the form for destruction.

  function CanFocus; override;

  

True when the form can receive the focus.

  procedure SetFocus; override;

  function SetFocusedControl(); virtual;

  

Handles focus switch to a control (enter/exit messages).

  procedure SetRestoredBounds();

  

Sets the bounds defining the restored control.

  procedure Show;

  

Makes the control visible, by setting Visible to True.

  function ShowModal; virtual;

  

Show this form as a modal Dialog.

  procedure ShowOnTop;

  

Shows this form in front of all other forms.

  function SmallIconHandle;

  

Returns (eventually creates) the Handle of the small Form or Application Icon.

  procedure GetChildren(); override;

  

Invokes Proc for all Controls and also for all Components with no Parent.

  function WantChildKey(); virtual;

  

  procedure RemoveAllHandlersOfObject(); override;

  

Override this method to remove all references to notification handlers in AnObject.

  procedure AddHandlerFirstShow();

  

Adds an handler for the first Show of the form.

  procedure RemoveHandlerFirstShow();

  

Removes an handler for the first Show of the form.

  procedure AddHandlerClose();

  

Adds an handler for form Close.

  procedure RemoveHandlerClose();

  

Removes an handler for form Close.

  procedure AddHandlerCreate();

  

Adds an handler for form Create.

  procedure RemoveHandlerCreate();

  

Removes an handler for form Create.

  function ActiveMDIChild; virtual;

  

Returns the currently active MDI child form.

  function GetMDIChildren(); virtual;

  function MDIChildCount; virtual;

  procedure AutoScale;

  procedure Dock(); override;

  

Moves the control into a new docksite.

  procedure UpdateDockCaption(); override;

  

Updates the Caption to reflect the names of the docked clients.

  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 Default control on the Form.

  property AllowDropFiles: Boolean; [rw]

  

Specifies whether files can be dropped onto this form.

  property AlphaBlend: Boolean; [rw]

  

Allows for a translucent form.

  property AlphaBlendValue: Byte; [rw]

  

How translucent the form is (0=transparent, 255=opaque).

  property AutoScroll: Boolean; [s]

  

  property BorderIcons: TBorderIcons; [rw]

  

Specifies which icons appear in the title bar of the form.

  property BorderStyle: TFormBorderStyle; [rw]

  

The border style affects the title bar, border and resize behaviour of the form.

  property CancelControl: TControl; [rw]

  

The control associated with the Cancel action.

  property Caption: TCaption; [s]

  

The text describing the control to the user.

  property Color: TColor;

  

The background color of the control.

  property DefaultControl: TControl; [rw]

  

The control associated with the default action for this form.

  property DefaultMonitor: TDefaultMonitor; [rw]

  

The monitor type on which the form shall appear.

  property Designer: TIDesigner; [rw]

  

The designer object when the form is in design state.

  property EffectiveShowInTaskBar: TShowInTaskbar; [r]

  property FormState: TFormState; [r]

  

Various state flags.

  property FormStyle: TFormStyle; [rw]

  

Determines the Style of the form (MDI, splash...).

  property HelpFile: string; [rw]

  

The name of the help file for this form.

  property Icon: TIcon; [rws]

  

The Icon associated with this Form (in minimized state).

  property KeyPreview: Boolean; [rw]

  

Allows the form to intercept keystrokes in child controls.

  property MDIChildren []: TCustomForm; [r]

  

Indexed access to MDI child forms, when this is an MDI form.

  property Menu: TMainMenu; [rw]

  

The main menu for this form.

  property ModalResult: TModalResult; [rw]

  

Specifies the return value of a modal form (dialog).

  property Monitor: TMonitor; [r]

  

The Monitor on which the form is shown.

  property PopupMode: TPopupMode; [rw]

  

Defines where popup menus are shown

  property PopupParent: TCustomForm; [rw]

  

  property OnActivate: TNotifyEvent; [rw]

  

Handler called when the form receives focus.

  property OnClose: TCloseEvent; [rws]

  

Handler called when the form is closed. It determines what happens to the form (destroy, hide...).

  property OnCloseQuery: TCloseQueryEvent; [rws]

  

Handler called before the form is closed. It can reject an close request.

  property OnCreate: TNotifyEvent; [rw]

  

Handler called when the form has been created.

  property OnDeactivate: TNotifyEvent; [rw]

  

Handler called when the form is deactivated (lost focus).

  property OnDestroy: TNotifyEvent; [rw]

  

Handler called when the form is destroyed.

  property OnDropFiles: TDropFilesEvent; [rw]

  

Handler called when files have been dropped.

  property OnHelp: THelpEvent; [rw]

  

Handler called when Help is requested.

  property OnHide: TNotifyEvent; [rw]

  

Handler called when the form is being hidden.

  property OnResize: TNotifyEvent; [s]

  

Notification handler for a resize of the control.

  property OnShortcut: TShortCutEvent; [rw]

  

Handler called when a key is pressed, before further handling of the key.

  property OnShow: TNotifyEvent; [rw]

  

Handler called when the form becomes visible.

  property OnShowModalFinished: TModalDialogFinished; [rw]

  property OnWindowStateChange: TNotifyEvent; [rw]

  

Handler called when the form is minimized, maximized or restored.

  property ParentFont: Boolean;

  

If true, the Font of the control will be the same as the one from the Parent. Default is true.

  property Position: TPosition; [rw]

  

The initial placement of the form.

  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]

  

How the form is represented in the system Task Bar.

  property Visible: Boolean; [s]

  

Allows to show or hide the control, and all of its children.

  property WindowState: TWindowState; [rw]

  

Whether the form is currently minimized, maximized or normal (restored).

Inheritance

TCustomForm

  

The base type for TForm.

|

TCustomDesignControl

|

TScrollingWinControl

  

Class of a windowed control with incorporated scroll bars.

|

TCustomControl

  

The base class for windowed controls which paint themselves.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components associated with widgets.

|

TComponent

?

TObject

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