ClassRadJumpList
Represents an instance of a Taskbar button jump list.
Definition
Namespace:Telerik.WinControls.Taskbar
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadJumpListInheritance: objectRadJumpList
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(RadTaskbarButton)
Declaration
public RadJumpList(RadTaskbarButton owner)Parameters
owner
RadJumpList(string, IntPtr)
Initializes a new RadJumpList instance for the application's taskbar button.
Declaration
public RadJumpList(string applicationId, IntPtr formHandle)Parameters
applicationId
Application Id for an individual form. This must be unique for each top-level form in order to have an individual JumpList.
formHandle
Handle of the form associated with this instance.
Properties
ApplicationId
Gets or sets the application ID.
Categories
A collection of custom jump list categories.
Declaration
public JumpListCategoryCollection Categories { get; }Property Value
KnownCategory
Gets or sets the type known category to display.
Declaration
public JumpListKnownCategory KnownCategory { get; set; }Property Value
KnownCategoryPosition
Gets or sets the position of the known category relative to the custom categories collection.
Declaration
public JumpListKnownCategoryPosition KnownCategoryPosition { get; set; }Property Value
MaxSlots
Gets the maximum number of items for the jump list.
Declaration
public int MaxSlots { get; }Property Value
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
List<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
Methods
AddRecentFile(string)
Reports document usage to the shell.
Declaration
public static void AddRecentFile(string path)Parameters
path
The full path of the file to report usage.
Refresh()
Commits the pending JumpList changes and refreshes the Taskbar.
Declaration
public void Refresh()Exceptions
Will throw if the type of the file being added to the JumpList is not registered with the application.
Will throw if recent documents tracking is turned off by the user or via group policy.
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 JumpItemsRemovedEvent Value
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.