Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

System.AppUserModel.RelaunchIconResource

Specifies the icon used for the shortcut created on the taskbar when the user chooses to pin an application to the taskbar or launch a new instance through its button's Jump List. This is the icon used for the taskbar group and is shown for a pinned application whether that application is running or not. This should be specified in one of the following formats:

  • Standard resource format, such as "%systemdir%\system32\shell32.dll,-128". The '-' character before the resource ID is required. Do not use the '@' character at the front of the path string.
  • Direct path to an icon file, such as "%programfiles%\Microsoft\Notepad\Notepad.ico,0". Note that because .ico files can contain multiple icon resources, a resource ID is required in the string. If the .ico file is a single image, use "0" (without the '-' character) as the resource ID.

System.AppUserModel.RelaunchIconResource is an optional property. If it is not set, the icon of the target of the relaunch command (System.AppUserModel.RelaunchCommand) is used. However, because that can lead to undesired results, we strongly encourage you to provide an icon explicitly through this property.

This property is used only if a window has an explicit Application User Model ID (AppUserModelID) (System.AppUserModel.ID, set through SHGetPropertyStoreForWindow). If the window does not have an explicit AppUserModelID (System.AppUserModel.ID), this property is ignored and the window is grouped and pinned as if it were part of its owning process. For more information on the application of explicit AppUserModelIDs and their effect on taskbar pinning, see Application User Model IDs (AppUserModelIDs). This property is meant to be used by applications or windows that want to provide non-default relaunch information. For more information, see System.AppUserModel.RelaunchCommand.

If an explicit AppUserModelID is set on the window, but this property is not set, the system attempts to find a shortcut with the same AppUserModelID, and pins that shortcut to the taskbar to represent the window. If no such shortcut can be located, then the backing executable of the process that owns it is used.

Note  This property is ignored if System.AppUserModel.PreventPinning is set. This enables an application to control the grouping of its windows by assigning them explicit AppUserModelIDs but preventing those windows from being pinned.

To set this property on a window, use SHGetPropertyStoreForWindow to retrieve the window's property store, and use the methods of that retrieved IPropertyStore object to set the System.AppUserModel.RelaunchIconResource property of that window.

propertyDescription
   name = System.AppUserModel.RelaunchIconResource
   shellPKey = PKEY_AppUserModel_RelaunchIconResource
   formatID = 9F4C2855-9F79-4B39-A8D0-E1D42DE1D5F3
   propID = 3
   searchInfo
      inInvertedIndex = false
      isColumn = false
      isColumnSparse = true
      columnIndexType = OnDemand
      maxSize = 128
      mnemonics
   labelInfo
      label
      sortDescription
      invitationText
      hideLabel = false
   typeInfo
      type = String
      groupingRange = Discrete
      isInnate = false
      canBePurged = true
      multipleValues = false
      isGroup = false
      aggregationType = Default
      isTreeProperty = false
      isViewable = false
      searchRawValue = false
      conditionType = String
      defaultOperation = Equal
   aliasInfo
      sortByAlias = None
      additionalSortByAliases = None
   displayInfo
      defaultColumnWidth = 20
      displayType
      alignment = Left
      relativeDescriptionType = General
      defaultSortDirection = Ascending
      stringFormat
         formatAs = General
      booleanFormat
         formatAs = YesNo
      numberFormat
         formatAs = General
         formatDurationAs = hh:mm:ss
      dateTimeFormat
         formatAs = General
         formatTimeAs = ShortTime
         formatDateAs = ShortDate
      enumeratedList
         defaultText
         useValueForDefault = False
         enum
            value
            text
            mnemonics
            image
         enumRange
            minValue
            setValue
            text
            mnemonics
            image
      drawControl
         control = Default
      editControl
         control = Default
      filterControl
         control = Default
      queryControl
         control = Default
   relatedPropertyInfo
      relatedProperty
         relationshipName
         propertyName

Related topics

Application User Model IDs (AppUserModelIDs)
System.AppUserModel.ID
propertyDescriptionList
propertyDescription
searchInfo
labelInfo
typeInfo
displayInfo
aliasInfo
stringFormat
booleanFormat
numberFormat
dateTimeFormat
enumeratedList
enum
enumRange
image
drawControl
editControl
filterControl
queryControl
relatedPropertyInfo
relatedProperty

 

 

Community Additions

Show:
© 2014 Microsoft