Vcl.CategoryButtons.TCategoryButtons.OnEdited

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property OnEdited: TCatButtonEditedEvent read FOnEdited write FOnEdited;

C++

__property TCatButtonEditedEvent OnEdited = {read=FOnEdited, write=FOnEdited};

Properties

Type Visibility Source Unit Parent
event published
Vcl.CategoryButtons.pas
Vcl.CategoryButtons.hpp
Vcl.CategoryButtons TCategoryButtons

Description

Occurs after the user edits the Caption property of a category button.

This event is triggered when a caption edit operation is completed as result of a call to EndEdit (False) or when the user presses Enter to complete the edit operation.

The parameters expected by OnEdited are listed in the following table:



Argument Meaning

Sender

Represents the TCategoryButtons control that the button belongs to.

Item

Represents the TBaseItem (button or category) whose caption was edited.

S

Indicates the value of the new caption that will be used. Code may be added to the event handler to replace or alter the new caption by assigning a new value to S. Assigning a blank string to S leaves the existing caption unchanged.



See Also

Code Examples