Vcl.JumpList.TCustomJumpList.DeleteList

• Up to Parent: TCustomJumpList

Delphi

function DeleteList: Boolean;

C++

bool __fastcall DeleteList();

Properties

Type	Visibility	Source	Unit	Parent
function	public	Vcl.JumpList.pas Vcl.JumpList.hpp	Vcl.JumpList	TCustomJumpList

Description

Removes any content that your application defined for its jump list, and returns True if the removal succeeds or False otherwise.

DeleteList removes from the jump list of your application any configuration that your application defined using the jump lists component. That includes:

• Your custom categories and category items.
• Your tasks.
• The configuration to show or hide recent and frequent files. For example, if you have both lists of files hidden, DeleteList restores the default Windows behavior of showing the recent files of your application.

Note: DeleteList does not remove any data from the jump list component, only from the actual jump list. If you call UpdateList right after you call DeleteList, the combination of both calls has no effect.

Exceptions

A call to DeleteList may raise any of the following exceptions:

Exception	Exception.Message	Scenarios
EJumpListException	JumpList exception: Error <code> Beginning List	ICustomDestinationList::BeginList returned an error code, and you either did not handle the OnListUpdateError event or your event handler did not mark the error as handled.
	JumpList exception: Error <code> Committing List	ICustomDestinationList::CommitList returned an error code, and you either did not handle the OnListUpdateError event or your event handler did not mark the error as handled.

See Also

• Vcl.JumpList.TCustomJumpList.CustomCategories
• Vcl.JumpList.TCustomJumpList.TaskList
• Vcl.JumpList.TCustomJumpList.ShowRecent
• Vcl.JumpList.TCustomJumpList.ShowFrequent

• Vcl.JumpList.TCustomJumpList.UpdateList
• Vcl.JumpList.TCustomJumpList.Enabled

• Vcl.JumpList.TCustomJumpList.OnItemDeleted
• Vcl.JumpList.TCustomJumpList.OnListUpdateError