Vcl.AppEvnts.TCustomApplicationEvents.CancelDispatch

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure CancelDispatch;

C++

void __fastcall CancelDispatch();

Properties

Type Visibility Source Unit Parent
procedure
function
public
Vcl.AppEvnts.pas
Vcl.AppEvnts.hpp
Vcl.AppEvnts TCustomApplicationEvents

Description

Prevents other TCustomApplicationEvents objects from receiving the current event.

Call CancelDispatch from one of the TCustomApplicationEvents descendant's event handlers when it handles an event. CancelDispatch prevents other TCustomApplicationEvents descendant's from receiving the event after the current event handler exits.

CancelDispatch has no effect unless it is called from one of the component's event handlers.