Export (0) Print
Expand All

System.AppUserModel.StartPinOption

Prevents a shortcut from being pinned to the Start screen by default or forces it to be deleted when it is unpinned.

Whenever possible, desktop apps should have only one tile on the Start screen to provide a shortcut that launches the app. Users should to use this shortcut to access all secondary actions of the app. If a secondary action needs a shortcut, you should use this property to remove (unpin) any extraneous shortcuts on the Start screen.

You can unpin unnecessary shortcuts by setting this property to one of the following enumeration values:

TermDescription

APPUSERMODEL_STARTPINOPTION_NOPINONINSTALL (1)

This option prevents the desktop app's tile from being automatically pinned as a shortcut to the Start screen when it is installed. The user will be able to see the app's tile through their view of all installed apps.

APPUSERMODEL_STARTPINOPTION_USERPINNED (2)

This option indicates that the tile is the result of the user asking the desktop app to pin a shortcut to an item (or link) to the Start screen. The desktop app must set this property value when it creates the shortcut. The resulting tile that is created by the app will be pinned to the Start screen, but will be permanently deleted if the tile is unpinned by the user.

 

This property serves a similar purpose to System.AppUserModel.ExcludeFromShowInNewInstall.

propertyDescription
   name = System.AppUserModel.StartPinOption
   shellPKey = PKEY_AppUserModel_StartPinOption
   formatID = 9F4C2855-9F79-4B39-A8D0-E1D42DE1D5F3
   propID = 12
   searchInfo
      inInvertedIndex = false
      isColumn = false
   labelInfo
      label = Start pin option
   typeInfo
      type = UInt32
      isInnate = false
   displayInfo
      enumeratedList
         enum
            name = Default
            value = 0
            text = Default
            defineToken = APPUSERMODEL_STARTPINOPTION_DEFAULT
         enum
            name = NoPinOnInstall
            value = 1
            text = NoPinOnInstall
            defineToken = APPUSERMODEL_STARTPINOPTION_NOPINONINSTALL
         enum
            name = UserPinned
            value = 2
            text = UserPinned
            defineToken = APPUSERMODEL_STARTPINOPTION_USERPINNED

Remarks

PKEY values are defined in Propkey.h.

Related topics

System.AppUserModel.ExcludeFromShowInNewInstall
propertyDescription
searchInfo
labelInfo
typeInfo
displayInfo
enumeratedList
enum

 

 

Community Additions

ADD
Show:
© 2014 Microsoft