New to Telerik UI for WinFormsStart a free 30-day trial

Represents an instance of a Taskbar button jump list.

Definition

Namespace:Telerik.WinControls.Taskbar

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class RadJumpList

Inheritance: objectRadJumpList

Constructors

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

C#
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.

C#
public RadJumpList(RadTaskbarButton owner)
Parameters:ownerRadTaskbarButton

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

C#
public RadJumpList(string applicationId, IntPtr formHandle)
Parameters:applicationIdstring

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

formHandleIntPtr

Handle of the form associated with this instance.

Properties

Gets or sets the application ID.

C#
public string ApplicationId { get; }

A collection of custom jump list categories.

C#
public JumpListCategoryCollection Categories { get; }

Gets or sets the type known category to display.

C#
public JumpListKnownCategory KnownCategory { get; set; }

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

C#
public JumpListKnownCategoryPosition KnownCategoryPosition { get; set; }

Gets the maximum number of items for the jump list.

C#
public int MaxSlots { get; }
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.

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.

C#
public List<string> RemovedDestinations { get; }
Property Value:

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

A collection of jump list tasks.

C#
public JumpListItemCollection<JumpTask> Tasks { get; }

Methods

Reports document usage to the shell.

C#
public static void AddRecentFile(string path)
Parameters:pathstring

The full path of the file to report usage.

Clears all added tasks.

C#
public void ClearTasks()

Commits the pending JumpList changes and refreshes the Taskbar.

C#
public void Refresh()
Exceptions:

InvalidOperationException

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

UnauthorizedAccessException

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

COMException

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

Events

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

C#
public event JumpItemsEventHandler JumpItemsRemoved
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.