Sign in Join
FPDoc Onlineexperiment

TCustomForm.DoClose procedure

Member of TCustomFormprotectedIn unit Forms

Notifies handlers of the close action for the form.

Declaration

pascal
procedure DoClose(var CloseAction: TCloseAction); virtual

Arguments

CloseAction

Close action to perform for the from instance.

Description

DoClose is a method used to notify close handlers for the form instance of the action requested in the CloseAction parameter.

It is called from the Close method for a form that is not displayed as a modal dialog; i. e. FormState does not contain fsModal. It occurs after CloseQuery (and OnCloseQuery) have been called to determine if the form can in fact be closed, and the CloseAction has been set for the form style.

DoClose signals the OnClose event handler (when assigned) to allow the form instance to modify the CloseAction argument. It iterates over the close handlers in the form instance, and signals each of the TCloseEvent instances in the method list using CloseAction as an argument.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.