Vcl.ComCtrls.TTBCustomizeQueryEvent

From RAD Studio API Documentation
Jump to: navigation, search

C++

typedef void __fastcall (__closure *TTBCustomizeQueryEvent)(TToolBar* Sender, int Index, bool &Allow);

Properties

Type Visibility Source Unit Parent
typedef public Vcl.ComCtrls.hpp Vcl.ComCtrls Vcl.ComCtrls

Description

TTBCustomizeQueryEvent is the type of event handlers that allow a toolbar to decide whether to allow a user customization.

TTBCustomizeQueryEvent is the type for the OnCustomizeCanInsert and OnCustomizeCanDelete events. It allows a toolbar to approve or block the insertion or deletion of a button by the user.

Sender is the customizable toolbar that the user is trying to modify.

Index is the index of the button to be deleted or the index where a new button is to be inserted.

Allow returns an indication of whether the user can proceed with the operation. On entry, Allow is True, indicating that the user can add or delete the button. The event handler can change Allow to False to block the change to the toolbar.

See Also