Shortcut Settings

InstallShield 2015 » Shortcuts View

Project: The Shortcuts view is available in the following project types:

•

Basic MSI

•

DIM

•

InstallScript

•

InstallScript MSI

•

Merge Module

•

MSI Database

•

MSM Database

•

Transform

The settings for a shortcut are organized into the following main categories in the Shortcuts view:

•

•

•

Use a shortcut’s Appearance settings to specify details such as the display name and the icon for the shortcut.

Appearance Settings

Setting

Project Type

Description

Display Name

Basic MSI, DIM, InstallScript, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

Enter the name of the shortcut as it should appear on the target system.

When you type a value for this setting, you are creating a string entry and setting its initial value for all of the languages that are currently in the project. As an alternative to typing a new value, you can click the ellipsis button (...) in this setting to select an existing string. For more information, see Using String Entries in InstallShield.

Project: For Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects—You must enter a value for this setting; otherwise, a build error occurs.

The display name is of the Windows Installer Filename data type. If the display name that you enter is not already in the 8.3 format, InstallShield uses the ShortName|LongName format for this setting. For example, if you enter My Product Name as the value in this setting, InstallShield sets the value to MyProd~1|My Product Name, or something similar, so that a short name is available at run time if needed.

Display Resource

Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

If you are preparing an installation for a multilingual application and you are separating language-neutral portable executable files from .mui files for the display name of your shortcut, use the following settings:

•

Display Resource—Click the ellipsis button (...) in this setting if you want to browse to the DLL file that contains the multilingual user interface (MUI) manifest.

InstallShield lists the path and file name in this setting if you do either of the following: you select a DLL file by browsing for it, or you manually enter a path and file name in the Display Resource DLL setting. InstallShield also lists the resource index that is specified in the Display Resource Index setting.

If this setting contains a value, the value for the Display Name setting is ignored. If you leave this setting blank, Windows Installer uses the value for the Display Name setting.

•

Display Resource DLL—If you want to manually specify the path and file name of the DLL file that contains the MUI manifest, enter it. You can include Windows Installer directory properties—for example, [INSTALLDIR]MyResource.dll—instead of hard-coded directory paths.

If you click the ellipsis button in the Display Resource setting to browse to the DLL file, InstallShield uses the format [#filekey] in the Display Resource DLL setting to identify the DLL file.

•

Display Resource Index—Specify the display name index for the shortcut. This must be a non-negative number.

Note: If you specify a DLL, you must also enter a value for the Display Resource Index setting.

These settings enable you to separate language-neutral portable executable files from .mui files, which contain all of the language-dependent resources, and later add resources for additional languages without having to recompile or relink the application.

Windows Vista and later and Windows Server 2008 and later include support for the display resource. Earlier systems ignore it.

Description

Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

Enter a description of the shortcut. The text that you enter is displayed as a tooltip when the end user places the mouse pointer over the shortcut. It is also displayed in the Description field of the shortcut’s Properties dialog box.

Description Resource

Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

If you are preparing an installation for a multilingual application and you are separating language-neutral portable executable files from .mui files for the description of your shortcut, use the following settings:

•

Description Resource—Click the ellipsis button (...) in this setting if you want to browse to the DLL file that contains the multilingual user interface (MUI) manifest.

InstallShield lists the path and file name in this setting if you do either of the following: you select a DLL file by browsing for it, or you manually enter a path and file name in the Description Resource DLL setting. InstallShield also lists the resource index that is specified in the Description Resource Index setting.

If this setting contains a value, the value for the Description setting is ignored. If you leave this setting blank, Windows Installer uses the value for the Description setting.

•

Description Resource DLL—If you want to manually specify the path and file name of the DLL file that contains the MUI manifest, enter it. You can include Windows Installer directory properties—for example, [INSTALLDIR]MyResource.dll—instead of hard-coded directory paths.

If you click the ellipsis button in the Description Resource setting to browse to the DLL file, InstallShield uses the format [#filekey] in the Description Resource DLL setting to identify the DLL file.

•

Description Resource Index—Specify the description index for the shortcut. This must be a non-negative number.

Note: If you specify a DLL, you must also enter a value for the Description Resource Index setting.

Windows Vista and later and Windows Server 2008 and later include support for the description resource. Earlier systems ignore it.

Icon

Basic MSI, DIM, InstallScript, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

To specify the icon that you want to be displayed for the shortcut, use the following settings:

•

Icon—Specify the file that contains the icon for the shortcut that you are creating. You must specify an .ico file or the executable file (.dll or .exe) that contains the icon resource. InstallShield lists the icon path and index in the Icon setting if you do either of the following: you select a file by browsing for it, or you manually enter a path and file name in the Icon File setting.

The method that you use to specify the file depends on the type of project that you are using.

Project: For Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects—Click the ellipsis button (...) in this setting if you want to browse to the .ico file or the .exe or .dll file that contains the icon resource.

For InstallScript projects—Click the ellipsis button (...) in this setting if you want to browse to the location on the target system of the .ico file or the .exe or .dll file that contains the icon resource.

•

Icon File—If you want to manually specify the path and name of the file that contains the icon, enter it.

•

Icon Index—If the icon file that you specify contains more than one icon resource, enter the index in this setting.

A nonnegative integer refers to the order of the icon resources in the executable file. For example, 0 refers to the first icon in the file, 1 refers to the second icon, and 2 refers to the third icon.

Use a negative number to refer to a specific resource ID. For example, the icon index -12 points to the icon with a resource ID of 12.

Project: For Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects—Note that because Windows Installer requires a separate icon file when the component is to be advertised, InstallShield extracts the first icon from the .exe or .dll file unless an icon index is specified. If you do not specify an icon file, the key file of this component is automatically used for the shortcut's icon.

Behavior

Use a shortcut’s Behavior settings to specify details such as the target and keyboard shortcut.

Behavior Settings

Setting

Project Type

Description

Advertised

Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

Specify whether you want to create an advertised shortcut.

If you select Yes and the end user advertises the product or the feature that contains the shortcut, the shortcut is created but the component’s files are not installed until the end user launches the shortcut. The first time that the shortcut is launched, the Windows Installer installs the component’s files and other data, and then the shortcut launches the target file. Every time that the shortcut is used from then on, it behaves like a normal shortcut.

Note: To create an advertised shortcut, the shortcut’s component must have a key file. The key file is the shortcut’s target.

Target

Basic MSI, DIM, InstallScript, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

Enter the path to the file on the target system that should be launched when end users launch the shortcut. As an alternative to manually entering a value, you can click the ellipsis button (...) to browse to the shortcut target.

Project: For Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects—Use Windows Installer directory properties—for example, [INSTALLDIR]File.exe—instead of hard-coded directory paths. If the shortcut is an advertised shortcut, this setting is read-only. The key file of the shortcut’s component is automatically set as the shortcut’s target. If the shortcut’s component does not have a key file, the shortcut will not function properly on the target system.

For InstallScript projects—Use system variables—for example, <TARGETDIR>\File.exe—instead of hard-coded directory paths.

Arguments

Basic MSI, DIM, InstallScript, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

Enter the command-line arguments for the shortcut. The arguments are added to the Target value on the shortcut’s Properties dialog box on the target system. These arguments work in the same way as any other command-line arguments. For example, you can link a file to an executable file or cause an executable file to run silently by passing command-line arguments.

Note: Verify that the syntax is correct because InstallShield does not do this.

Tip: Use %1 in the argument for the selected file name. For example, if the end user right-clicks the file C:\File.ext and -p %1 is the argument for this shortcut, the command-line argument becomes -p C:\File.ext. In some cases, it is necessary to enclose the %1 argument in quotation marks—as in "%1"—to correctly handle file names that contain spaces.

Working Directory

Basic MSI, DIM, InstallScript, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

Enter the working directory for the shortcut target, or click the ellipsis button (...) to select or create a directory.

The directory that you specify is displayed as the Start in field on the shortcut’s Properties dialog box on the target system. The working directory is the default directory that is displayed in standard file-opening and file-saving dialog boxes, as well as the current directory used by the product.

Project: For example, in Basic MSI, DIM, InstallScript, InstallScript MSI, Merge Module, MSI Database, MSM Database, and Transform projects, if you want your working directory to be set to a subdirectory of INSTALLDIR called Files, select [INSTALLDIR] from the list and add the subdirectory name Files to the end of it. When you are finished, it should read [INSTALLDIR]Files.

In an InstallScript project, if you want your working directory to be set to a subdirectory of TARGETDIR called Files, select <TARGETDIR> from the list and add the text \Files to the end of it. When you are finished, it should read <TARGETDIR>\Files.

Hot Key

Basic MSI, DIM, InstallScript, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

This setting contains the decimal value of the keyboard shortcut that is assigned to your shortcut. You can assign a keyboard shortcut to your product’s shortcut so that end users can press the appropriate hot keys to launch the shortcut.

If you want InstallShield to calculate the decimal value of the keyboard shortcut, click the ellipsis button (...) in this setting.

For more information, see Specifying a Keyboard Shortcut for Accessing a Shortcut.

Caution: It is recommended that you avoid configuring keyboard shortcuts for your shortcuts because they may conflict with existing keyboard shortcuts on the target system.

Run

Basic MSI, DIM, InstallScript, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

Select the style of window that the target file should use when end users launch the shortcut. Available options are:

•

Normal Window—The file is launched in a standard-sized window.

•

Maximized Window—The file is launched in full-screen view.

•

Minimized Window—The file is launched in a minimized window, visible only on the taskbar.

Pin to Windows 8 Start Screen

Basic MSI, DIM, InstallScript, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

Specify whether you want the shortcut to be pinned by default to the Start screen on Windows 8 target systems. Available options are:

•

Yes—When the shortcut is installed on Windows 8 systems, it is pinned to the Start screen. End users can optionally unpin the shortcut. This is the default option.

•

No—When the shortcut is installed on Windows 8 systems, it is not pinned to the Start screen. It is available in the Apps list that contains shortcuts to all of the applications on the system.

For more information, see Specifying Whether a Shortcut Should Be Pinned to the Windows 8 Start Screen.

Prevent Pinning

InstallScript

Specify whether you want to prevent end users from being able to pin a shortcut to the taskbar and to the Start menu after end users install your product. Available options are:

•

Yes—When the shortcut is installed, the context menu commands for pinning a shortcut to the taskbar and to the Start menu are hidden.

•

No—When the shortcut is installed, the context menu commands for pinning the shortcut to the taskbar and to the Start menu are available, enabling end users to pin the shortcut. This is the default option.

Windows 7 introduced support for this setting. Earlier versions of Windows ignore this setting.

You may want to disable pinning for shortcuts that are for tools and secondary products that are part of your installation. Note that if you configure the shortcut to prevent this pinning, the target of the shortcut is ineligible for inclusion in the most frequently used list on the Start menu.

For more information, see Specifying Whether End Users Should Be Able to Pin a Shortcut to the Taskbar or Start Menu.

Do Not Highlight as New

InstallScript

Specify whether you want to prevent a shortcut on the Start menu from being highlighted as newly installed after end users install your product. Available options are:

•

Yes—If the installation adds the shortcut to the Start menu, the shortcut is not highlighted as newly installed. This has the same effect as clearing the Highlight newly installed programs check box in the Customize Start Menu dialog box for an individual item on a target system.

•

No—If the installation adds the shortcut to the Start menu, the shortcut is highlighted as newly installed. This is the default option.

Windows 7 introduced support for this setting. Earlier versions of Windows ignore this setting.

You may want to select Yes for shortcuts that are for tools and secondary products that are part of your installation.

For more information, see Preventing a Shortcut on the Start Menu from Being Highlighted as Newly Installed.

General

Use a shortcut’s General settings to specify details such as the component that contains the shortcut.

General Settings

Setting

Project Type

Description

Key Name

Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

Enter a key name for the shortcut. The key name is an internal name; it is not displayed to end users.

Internal Name

InstallScript

Enter an internal name for the shortcut. The internal name is not displayed to end users.

Component

Basic MSI, DIM, InstallScript, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

This setting indicates the component that contains the shortcut. Click the ellipsis button (...) to display the Browse for a Component dialog box, which lets you create new components or select an existing component for the shortcut.

The shortcut is created on the target system if the selected component is installed.

Project: In InstallScript projects, you can select more than one component for the shortcut.

Feature

Basic MSI, InstallScript MSI, MSI Database, Transform

This setting indicates the feature or features with which the shortcut component is associated. If there is no feature-component association, this setting is blank.

Uninstall

InstallScript

Specify whether the shortcut should be removed when the product is uninstalled.

Replace Existing (If Found)

InstallScript

Specify whether the shortcut should overwrite an already existing shortcut with the same display name in the same location on the target system.

Internet Shortcut

InstallScript

Specify whether the shortcut is an Internet shortcut. The default setting is No; if you select Yes, the Target setting for the shortcut should be a valid URL.

VS .NET Project Output

InstallScript

Specify whether the shortcut points to a Visual Studio project output.

Type

InstallScript

Specify how the shortcut should be created. Available options are:

•

Automatic—The installation automatically determines where the shortcut should appear based on the value of the ALLUSERS system variable.

If ALLUSERS is non-zero, the shortcut is created in the All Users profile so that it is available on the target system for all end users. If ALLUSERS is FALSE, the shortcut is created in the current user’s profile.

•

Personal—The shortcut is created in the current user’s profile.

•

Common—The shortcut is created in the All Users profile.

Comments

Basic MSI, DIM, InstallScript, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

Enter comments for this shortcut. Comments are saved in the project file for your reference and are not displayed to the end user.

Shell Properties

Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

This setting lets you specify one or more shortcut properties that need to be set by the Windows Shell at run time.

To specify one or more properties, click the Add New Shell Shortcut Property button in this setting, and then click one of the available options:

•

Prevent Pinning—The context menu commands for pinning the shortcut to the taskbar or the Start menu are not displayed for this shortcut after end users install your product. In addition, this option makes the target of the shortcut ineligible for inclusion in the most frequently used list on the Start menu.

If you select this option, InstallShield adds a Key Name setting, plus additional rows of subsettings, and configures them as needed.

•

Do Not Highlight as New—The Start menu entry for the shortcut is not highlighted as newly installed after end users install your product. This has the same effect as clearing the Highlight newly installed programs check box in the Customize Start Menu dialog box for an individual item on a target system. You may want to set this property for shortcuts that are for tools and secondary products that are part of your installation.

If you select this option, InstallShield adds a Key Name setting, plus additional rows of subsettings, and configures them as needed.

•

Custom Property—To specify a custom property and value for shortcut properties that need to be set by the Windows Shell at installation run time, select this option. InstallShield adds a new Key Name setting, plus additional subsettings, that let you configure the appropriate property name and value.

Specify additional properties as needed.

Note: Windows Installer 5 introduced support for the Shell property settings. Earlier versions of Windows Installer ignore these settings.

For more information, see Setting Shell Properties for a Shortcut.

Key Name

Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

This setting is displayed if you have used the Shell Properties setting to add one or more Shell properties to your shortcut.

Enter a key name for the Shell shortcut property. The key name is an internal name; it is not displayed to end users.

Note: Windows Installer 5 introduced support for the Shell property settings. Earlier versions of Windows Installer ignore these settings.

For more information, see Setting Shell Properties for a Shortcut.

Property

Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

This setting is displayed if you have used the Shell Properties setting to add one or more Shell properties to your shortcut.

Enter the shortcut property that you want the Windows Shell to set at run time.

Note: Windows Installer 5 introduced support for the Shell property settings. Earlier versions of Windows Installer ignore these settings.

For more information, see Setting Shell Properties for a Shortcut.

Value

Basic MSI, DIM, InstallScript MSI, Merge Module, MSI Database, MSM Database, Transform

This setting is displayed if you have used the Shell Properties setting to add one or more Shell properties to your shortcut.

Enter the value for the Shell shortcut property.

Note: Windows Installer 5 introduced support for the Shell property settings. Earlier versions of Windows Installer ignore these settings.

For more information, see Setting Shell Properties for a Shortcut.

Shortcut Settings

InstallShield 2015 Help Library

June 2015