Vcl.JumpList.TCustomJumpList.AddTask

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function AddTask(const FriendlyName: string; const Path: string = ''; const Arguments: string = '';
const Icon: string = ''): TJumpListItem;

C++

TJumpListItem* __fastcall AddTask(const System::UnicodeString FriendlyName, const System::UnicodeString Path = System::UnicodeString(), const System::UnicodeString Arguments = System::UnicodeString(), const System::UnicodeString Icon = System::UnicodeString());

Properties

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

Description

Adds a list item to the built-in "Tasks" category, and returns your new list item.

AddTask lets you add list items to the built-in "Tasks" category at run time. Use the TasksList property of your jump lists object to define your list items at design time.

Use the parameters of AddTask to define the properties of your new list item:

Parameter Property Notes

FriendlyName

FriendlyName

  • Must be a non-empty string.

Path

Path

Arguments

Arguments

Icon

Icon

AddTask makes the Visible property of the new list item True. Also, new list items are not separators by default.

After you call AddTask, remember to refresh the jump lists if you have not enabled AutoRefresh:

Delphi:

JumpLists1.AddTask('MyItem');
JumpLists1.UpdateList;

C++:

JumpLists1->AddTask("MyItem");
JumpLists1->UpdateList();

This is the result:

JumpListsTaskListMyItem.png

See Also