Vcl.Forms.TApplication.OnActionUpdate

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property OnActionUpdate: TActionEvent read FOnActionUpdate write FOnActionUpdate;

C++

__property System::Classes::TActionEvent OnActionUpdate = {read=FOnActionUpdate, write=FOnActionUpdate};

Properties

Type Visibility Source Unit Parent
event public
Vcl.Forms.pas
Vcl.Forms.hpp
Vcl.Forms TApplication

Description

Occurs when an action's Update method is called and its action list has not already handled it.

Use the OnActionUpdate event handler to update the properties of an action when the application is idle if the action's action list does not handle it in an OnUpdate event handler.

If the action list that contains the action does not update it in an OnUpdate event handler, the action is routed to the application object's UpdateAction method, which invokes the OnActionUpdate event handler. (The application's UpdateAction method applies to all actions in the application.)

The Handled parameter of the event handler returns false by default. If the handler updates the event, it should change Handled to true, thereby ending the processing of the action. When the event handler exits with Handled set to false, the action's OnUpdate event occurs. If the action is not updated after that, the active control's UpdateAction method is called to allow the target to update the action. Finally, the active form's UpdateAction method is called if all other handlers do not handle the action.

Note: OnActionUpdate occurs after the application's OnIdle event.

Note: You can also respond to this event using the TApplicationEvents component, which allows you to assign an event handler using the IDE.

See Also

Code Examples