Edit

Share via


JumpTask.IconResourceIndex Property

Definition

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

public:
 property int IconResourceIndex { int get(); void set(int value); };
public int IconResourceIndex { get; set; }
member this.IconResourceIndex : int with get, set
Public Property IconResourceIndex As Integer

Property Value

The zero-based index of the icon, or -1 if no icon is used. The default is 0.

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"/>

Remarks

An icon used with a JumpTask must be available as a native resource. If multiple icons are available in a DLL or executable file, you specify the one to use by indicating an offset in the IconResourceIndex property.

If no icon resource is specified, or if the specified icon is not found, the standard system icon is displayed. To specify that no icon is displayed, set the IconResourceIndex property to -1.

Applies to

See also