Share via


JumpTask Class

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

Inheritance Hierarchy

System.Object
  Microsoft.Windows.Shell.JumpItem
    Microsoft.Windows.Shell.JumpTask

Namespace:  Microsoft.Windows.Shell
Assembly:  Microsoft.Windows.Shell (in Microsoft.Windows.Shell.dll)

Syntax

'Declaration
Public Class JumpTask _
    Inherits JumpItem
public class JumpTask : JumpItem
public ref class JumpTask : public JumpItem
type JumpTask =  
    class
        inherit JumpItem
    end
public class JumpTask extends JumpItem

The JumpTask type exposes the following members.

Constructors

  Name Description
Public method JumpTask Initializes a new instance of the JumpTask class.

Top

Properties

  Name Description
Public property ApplicationPath Gets or sets the path to the application.
Public property Arguments Gets or sets the arguments passed to the application on startup.
Public property CustomCategory Gets or sets the name of the category the JumpItem is grouped with in the Windows 7 taskbar Jump List. (Inherited from JumpItem.)
Public property Description Gets or sets the text displayed in the tooltip for the task in the Jump List.
Public property IconResourceIndex Gets or sets the zero-based index of an icon embedded in a resource.
Public property IconResourcePath Gets or sets the path to a resource that contains the icon to display in the Jump List.
Public property Title Gets or sets the text displayed for the task in the Jump List.
Public property WorkingDirectory Gets or sets the working directory of the application on startup.

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Windows.Shell Namespace

JumpPath

JumpList

JumpItemsRejected

Startup

Args