Show: Delphi C++
Display Preferences


From RAD Studio API Documentation
Jump to: navigation, search


property OnClick: TNotifyEvent read FOnClick write FOnClick stored IsOnClickStored;


__property System::Classes::TNotifyEvent OnClick = {read=FOnClick, write=FOnClick, stored=IsOnClickStored};


Type Visibility Source Unit Parent
event protected
Vcl.Controls TControl


Occurs when the user clicks the control.

Use the OnClick event handler to respond when the user clicks the control. If the control has an associated action, and that action has an OnExecute method, the action's OnExecute method responds to click events unless it is superseded by an OnClick event handler.

Usually, OnClick occurs when the user presses and releases the left mouse button with the mouse pointer over the control. This event can also occur when:

  • The user selects an item in a grid, outline, list, or combo box by pressing an arrow key.
  • The user presses the SPACEBAR while a button or check box has focus.
  • The user presses ENTER when the active form has a default button (specified by the Default property).
  • The user presses ESC when the active form has a cancel button (specified by the Cancel property).
  • The user presses the accelerator key for a button or check box. For example, if the value of the Caption property of a check box is '&Bold', the B is underlined at run time and the OnClick event of the check box is triggered when the user presses Alt+B. However, focus does not move to the control in these instances.
  • The Checked property of a radio button is set to True.
  • The value of the Checked property of a check box is changed.
    Note: When you change the value of the Checked property programmatically, the OnClick event of the check box control occurs. Do not modify the value of the Checked property in the event handler of the OnClick event, because that leads into a deadlock situation.
  • The Click method of a menu item is called.

For a form, an OnClick event occurs when the user clicks a disabled component or in a blank area of the form.

OnClick is an event handler of type TNotifyEvent.

See Also

Code Examples

Personal tools
In Other Languages
Previous Versions