Show: Delphi C++
Display Preferences

FMX.Forms.TCommonCustomForm.OnClose

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property OnClose: TCloseEvent read FOnClose write FOnClose;

C++

__property TCloseEvent OnClose = {read=FOnClose, write=FOnClose};

Properties

Type Visibility Source Unit Parent
event public
FMX.Forms.pas
FMX.Forms.hpp
FMX.Forms TCommonCustomForm

Description

Occurs when the form closes.

Use OnClose to perform special processing when the form closes. The OnClose event specifies which event handler to call when a form is about to close. The handler specified by OnClose might, for example, test that all fields in a data entry form have valid contents before allowing the form to close.

A form is closed by the Close method or when the user chooses Close from the form's system menu.

The TCloseEvent type points to a method that handles the closing of a form. The value of the Action parameter determines whether the form actually closes.

The following table lists the possible values of Action:


Value Meaning

caNone

The form is not allowed to close, so nothing happens.

caHide

The form is not closed, but just hidden. Your application can still access a hidden form. This is the default value for Action.

caFree

The form is closed and all allocated memory for the form is freed.

caMinimize

The form is minimized, rather than closed.


By default, Action is set to caHide.

To close the form and free it in an OnClose event, set Action to caFree.

Note: When the application shuts down, the main form receives an OnClose event, but any child forms do not receive the OnClose event.

See Also

Personal tools
In Other Languages
Previous Versions
Assistance