PreferredApplicationPackageFamilyName | preferredApplicationPackageFamilyName property

LauncherOptions.PreferredApplicationPackageFamilyName | preferredApplicationPackageFamilyName property

Gets or sets a value that represents the package family name of the app in the Store that the user should install if no app exists to handle the file type or URI.


Public Property PreferredApplicationPackageFamilyName As String

Property value

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The package family name of the app.


In some cases the user may not have an app installed to handle the file that you are launching. By default, Windows will handle these cases by providing the user with a link to search for an appropriate app on the store. Use LauncherOptions.PreferredApplicationDisplayName in conjunction with LauncherOptions.preferredApplicationPackageFamilyName to provide the user with an app in the Windows Store that they can acquire to handle the file. The display name that you use should correspond to the display name of the app in the Windows Store.

You must set both of these preferred application properties to recommend an app. Setting one without the other will result in a failure.

Note  You cannot set the preferred application properties and the fallback URI at the same time, since only one fallback may be used. The Launcher API will fail if both fallbacks are set.
Important  This property is only implemented on Desktop devices.


Call the Launcher.LaunchFileAsync(IStorageFile, LauncherOptions) | launchFileAsync(IStorageFile, LauncherOptions) method with preferredApplicationDisplayName set to the display name of an app in the Windows Store and the preferredApplicationPackageFamilyName set to the package family name of an app in the Windows Store.

async Sub DefaultLaunch()

   ' Path to the file in the app package to launch
   Dim imageFile = "images\test.png"

   ' Get the image file from the package's image directory
   Dim file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile)

   If file IsNot Nothing Then
      ' Set the recommended app
      Dim options = Windows.System.LauncherOptions()
      options.PreferredApplicationPackageFamilyName = “Contoso.FileApp_8wknc82po1e”;
      options.PreferredApplicationDisplayName = “Contoso File App”;

      ' Launch the retrieved file pass in the recommended app 
      ' in case the user has no apps installed to handle the file
      Dim success = await Windows.System.Launcher.LaunchFileAsync(file)

      If success Then
         ' File launched
         ' File launch failed
      End If
      ' Could not find file
   End If
End Sub

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0


Windows::System [C++]



Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]


Windows::System [C++]



See also

Association launching sample
How to launch the default app for a file (JavaScript)
Launch the default app for a file
How to launch the default app for a URI (JavaScript)
Launch the default app for a URI
Guidelines for file types and URIs
Launcher.LaunchFileAsync(IStorageFile, LauncherOptions)
Launcher.LaunchUriAsync(Uri, LauncherOptions)



© 2016 Microsoft