Edit

Share via

JumpTask Class

  • Reference

Definition

Namespace:
System.Windows.Shell
Assembly:
PresentationFramework.dll

Represents a shortcut to an application in the Windows 7 taskbar Jump List.

public ref class JumpTask : System::Windows::Shell::JumpItem
public class JumpTask : System.Windows.Shell.JumpItem
type JumpTask = class
    inherit JumpItem
Public Class JumpTask
Inherits JumpItem
Inheritance
Object
JumpItem
JumpTask

Examples

The following example shows how to declare a JumpTask in markup. The JumpTask opens a text file named readme.txt in the Notepad application.

<JumpTask Title="Read Me" 
          Description="Open readme.txt in Notepad." 
          ApplicationPath="C:\Windows\notepad.exe"
          IconResourcePath="C:\Windows\System32\imageres.dll"
          IconResourceIndex="14"
          WorkingDirectory="C:\Users\Public\Documents"
          Arguments="readme.txt"/>

The following example shows how to configure a JumpTask in code. The JumpTask opens the Calculator application.

// Configure a new JumpTask.
JumpTask jumpTask1 = new JumpTask();
// Get the path to Calculator and set the JumpTask properties.
jumpTask1.ApplicationPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.SystemX86), "calc.exe");
jumpTask1.IconResourcePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.SystemX86), "calc.exe");
jumpTask1.Title = "Calculator";
jumpTask1.Description = "Open Calculator.";
jumpTask1.CustomCategory = "User Added Tasks";

Remarks

A JumpTask can be thought of as a shortcut to an application. You specify the path to the executable file by setting the ApplicationPath property. If the ApplicationPath is not set, the path of the current running process is implied. You can optionally specify Arguments to pass to the application at startup.

You can set basic display properties, such as Title, Description, and IconResourcePath to specify the appearance of the task in the Jump List. An icon used with a JumpTask must be available as a native resource. If multiple icon resources are available in a DLL or executable file, you specify the one to use by indicating an offset in the IconResourceIndex property.

By default, a JumpTask will be placed in the Tasks category of the Jump List. You can specify custom grouping of tasks by setting the CustomCategory property.

You can visually separate items in a Jump List by creating a JumpTask that does not have a Title and CustomCategory specified. This empty JumpTask will be displayed as a horizontal line in the Jump List. In this case, other properties can be set, but they will not have any effect.

Constructors

JumpTask()

Initializes a new instance of the JumpTask class.

Properties

ApplicationPath

Gets or sets the path to the application.
Arguments

Gets or sets the arguments passed to the application on startup.
CustomCategory

Gets or sets the name of the category the JumpItem is grouped with in the Windows 7 taskbar Jump List.

(Inherited from JumpItem)
Description

Gets or sets the text displayed in the tooltip for the task in the Jump List.
IconResourceIndex

Gets or sets the zero-based index of an icon embedded in a resource.
IconResourcePath

Gets or sets the path to a resource that contains the icon to display in the Jump List.
Title

Gets or sets the text displayed for the task in the Jump List.
WorkingDirectory

Gets or sets the working directory of the application on startup.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also