Class RadJumpList

Represents an instance of a Taskbar button jump list.

Inheritance
System.Object
RadJumpList
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.Taskbar
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadJumpList

Constructors

RadJumpList()

Initializes a new RadJumpList instance for the application's taskbar button.

Declaration
public RadJumpList()
Remarks

If there are any other child (top-level) forms for this application and they don't have a specific JumpList created for them, they all will share the same JumpList. In order to have a individual JumpList for a top-level form, use the overloaded constructor with Handle parameter.

RadJumpList(String, IntPtr)

Initializes a new RadJumpList instance for the application's taskbar button.

Declaration
public RadJumpList(string applicationId, IntPtr formHandle)
Parameters
System.String applicationId

Application Id for an individual form. This must be unique for each top-level form in order to have an individual JumpList.
System.IntPtr formHandle

Handle of the form associated with this instance.

RadJumpList(RadTaskbarButton)

Declaration
public RadJumpList(RadTaskbarButton owner)
Parameters
RadTaskbarButton owner

Properties

ApplicationId

Gets or sets the application ID.

Declaration
public string ApplicationId { get; }
Property Value
System.String

Categories

A collection of custom jump list categories.

Declaration
public JumpListCategoryCollection Categories { get; }
Property Value
JumpListCategoryCollection

KnownCategory

Gets or sets the type known category to display.

Declaration
public JumpListKnownCategory KnownCategory { get; set; }
Property Value
JumpListKnownCategory

KnownCategoryPosition

Gets or sets the position of the known category relative to the custom categories collection.

Declaration
public JumpListKnownCategoryPosition KnownCategoryPosition { get; set; }
Property Value
JumpListKnownCategoryPosition

MaxSlots

Gets the maximum number of items for the jump list.

Declaration
public int MaxSlots { get; }
Property Value
System.Int32

Remarks

This number doesn’t imply or suggest how many items will appear on the jump list.
This number should only be used for reference purposes since the actual number of slots in the jump list can change after the last refresh due to items being pinned or removed and resolution changes. The jump list can increase in size accordingly.

RemovedDestinations

Retrieves the current list of destinations that have been removed from the existing jump list by the user. The removed destinations may become items on a custom jump list.

Declaration
public List<string> RemovedDestinations { get; }
Property Value
System.Collections.Generic.List<System.String>

A collection of items (filenames) removed from the existing jump list by the user.

Tasks

A collection of jump list tasks.

Declaration
public JumpListItemCollection<JumpTask> Tasks { get; }
Property Value
JumpListItemCollection<JumpTask>

Methods

AddRecentFile(String)

Reports document usage to the shell.

Declaration
public static void AddRecentFile(string path)
Parameters
System.String path

The full path of the file to report usage.

ClearTasks()

Clears all added tasks.

Declaration
public void ClearTasks()

Refresh()

Commits the pending JumpList changes and refreshes the Taskbar.

Declaration
public void Refresh()
Exceptions
System.InvalidOperationException

Will throw if the type of the file being added to the JumpList is not registered with the application.
System.UnauthorizedAccessException

Will throw if recent documents tracking is turned off by the user or via group policy.
System.Runtime.InteropServices.COMException

Will throw if updating the JumpList fails for any other reason.

Events

JumpItemsRemoved

Occurs when items are removed from the Taskbar's jump list since the last refresh.

Declaration
public event JumpItemsEventHandler JumpItemsRemoved
Event Type
JumpItemsEventHandler

Remarks

This event is not triggered immediately when a user removes an item from the jump list but rather when the application refreshes the task bar list directly.

Extension Methods