Class JumpList

Manage the tasks and files that Shell associates with this application. This allows modification of the Jump List UI in Windows 7 that appears on the Taskbar and Start Menu.

Inheritance

System.Object

JumpList

Implements

System.ComponentModel.ISupportInitialize

Namespace: Syncfusion.Windows

Assembly: Syncfusion.Shared.WPF.dll

Syntax

public sealed class JumpList : Object, ISupportInitialize

Constructors

JumpList()

Declaration

public JumpList()

JumpList(IEnumerable<JumpItem>, Boolean, Boolean)

Declaration

public JumpList(IEnumerable<JumpItem> items, bool showFrequent, bool showRecent)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<JumpItem>	items
System.Boolean	showFrequent
System.Boolean	showRecent

Properties

JumpItems

The list of JumpItems to be in the JumpList. After a call to Apply this list will contain only those items that were successfully added.

Declaration

public List<JumpItem> JumpItems { get; }

Property Value

Type
System.Collections.Generic.List<JumpItem>

Remarks

This object is not guaranteed to retain its identity after a call to Apply or other implicit setting of the JumpList. It should be requeried at such times.

ShowFrequentCategory

Whether to show the special "Frequent" category.

Declaration

public bool ShowFrequentCategory { get; set; }

Property Value

Type
System.Boolean

Remarks

This category is managed by the Shell and keeps track of items that are frequently accessed by this program. Applications can request that specific items are included here by calling JumpList.AddToRecentCategory. Because of duplication, applications generally should not have both ShowRecentCategory and ShowFrequentCategory set at the same time.

ShowRecentCategory

Whether to show the special "Recent" category.

Declaration

public bool ShowRecentCategory { get; set; }

Property Value

Type
System.Boolean

Remarks

This category is managed by the Shell and keeps track of items that have been recently accessed by this program. Applications can request that specific items are included here by calling JumpList.AddToRecentCategory Because of duplication, applications generally should not have both ShowRecentCategory and ShowFrequentCategory set at the same time.

Methods

AddToRecentCategory(JumpPath)

Add the item to the application's JumpList's recent items.

Declaration

public static void AddToRecentCategory(JumpPath jumpPath)

Parameters

Type	Name	Description
JumpPath	jumpPath

Remarks

This makes the item eligible for inclusion in the special Recent and Frequent categories.

AddToRecentCategory(JumpTask)

Add the task at the specified file path to the application's JumpList's recent items.

Declaration

public static void AddToRecentCategory(JumpTask jumpTask)

Parameters

Type	Name	Description
JumpTask	jumpTask

Remarks

This makes the item eligible for inclusion in the special Recent and Frequent categories.

AddToRecentCategory(String)

Add the item at the specified file path to the application's JumpList's recent items.

Declaration

public static void AddToRecentCategory(string itemPath)

Parameters

Type	Name	Description
System.String	itemPath

Remarks

This makes the item eligible for inclusion in the special Recent and Frequent categories.

Apply()

Declaration

public void Apply()

BeginInit()

Prepare the JumpList for modification.

Declaration

public void BeginInit()

Remarks

This works in concert with the Application.JumpList attached property. The JumpList will automatically be applied to the current application when attached and a corresponding call to EndInit is made. Nested calls to BeginInit are not allowed.

EndInit()

Signal the end of initialization of this JumpList. If it is attached to the current Application, apply the contents of the jump list.

Declaration

public void EndInit()

Remarks

Calls to EndInit must be paired with calls to BeginInit.

GetJumpList(Application)

Get the JumpList attached property for an Application.

Declaration

public static JumpList GetJumpList(Application application)

Parameters

Type	Name	Description
System.Windows.Application	application

Returns

Type
JumpList

SetJumpList(Application, JumpList)

Set the JumpList attached property on an Application.

Declaration

public static void SetJumpList(Application application, JumpList value)

Parameters

Type	Name	Description
System.Windows.Application	application
JumpList	value

Events

JumpItemsRejected

Declaration

public event EventHandler<JumpItemsRejectedEventArgs> JumpItemsRejected

Event Type

Type
System.EventHandler<JumpItemsRejectedEventArgs>

JumpItemsRemovedByUser

Declaration

public event EventHandler<JumpItemsRemovedEventArgs> JumpItemsRemovedByUser

Event Type

Type
System.EventHandler<JumpItemsRemovedEventArgs>

Implements

System.ComponentModel.ISupportInitialize