Vcl.JumpList.TCustomJumpList.OnListUpdateError
Delphi
property OnListUpdateError: TCreatingListErrorEvent read FOnListUpdateError write FOnListUpdateError;
C++
__property TCreatingListErrorEvent OnListUpdateError = {read=FOnListUpdateError, write=FOnListUpdateError};
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| event | public | Vcl.JumpList.pas Vcl.JumpList.hpp |
Vcl.JumpList | TCustomJumpList |
Description
Occurs when there is an error updating the jump list of your application.
Your jump list component updates the jump list of your application when:
- Your form loads your jump list component.
- You call DeleteList or UpdateList.
- You set the AutoRefresh property to
True. - Have AutoRefresh enabled, and change the value of CustomCategories, ShowFrequent, ShowRecent, or TasksList.
The OnListUpdateError event lets you handle the error yourself, check the error information, and decide whether the error should raise an exception or not.
The event handler of OnListUpdateError receives the following parameters:
Senderis your jump list component.WinErrorCodeis the code of the error as defined by the Windows Jump Lists API.ErrorDescriptionis a human-readable description of the error.Handleddetermines whether the error should raise an exception or not. To raise an exception, setHandledtoFalse; otherwise, setHandledtoTrue.