JumpList.JumpItems Property

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the collection of JumpItem objects that are displayed in the Jump List.

Namespace:   System.Windows.Shell
Assembly:  PresentationFramework (in PresentationFramework.dll)

public List<JumpItem> JumpItems { get; }

Property Value

Type: System.Collections.Generic.List<JumpItem>

The collection of JumpItem objects displayed in the Jump List. The default is an empty collection.

Jump Lists can contain two types of items, a JumpTask and a JumpPath. A JumpTask is a link to a program and a JumpPath is a link to a file.

When a JumpList is created, the JumpItems collection is empty. You can add any JumpTask or JumpPath objects to the collection. The collection will only contain items that have been added by your program. After the JumpList has been passed to the Windows shell by a successful call to either the EndInit or Apply methods, the JumpItems collection will contain only the items that were successfully added to the taskbar Jump List. Items that were not successfully added are removed from the JumpItems collection. You can access the lists of removed items through event handlers for the JumpItemsRejected and JumpItemsRemovedByUser events.

The following example shows how to get the current JumpList and clear the contents of the JumpItems collection. The Apply method is then called to apply the JumpList changes to the Windows shell. This example is part of a larger example available in the JumpList class overview.

private void ClearJumpList(object sender, RoutedEventArgs e)
{
    JumpList jumpList1 = JumpList.GetJumpList(App.Current);
    jumpList1.JumpItems.Clear();
    jumpList1.Apply();
}

.NET Framework
Available since 4.0
Return to top
Show: