LauncherOptions Class

Definition

Namespace:

Windows.System

Specifies the options used to launch the default app for a file or URI.

In a desktop app, before using an instance of this class in a way that displays UI, you'll need to associate the object with its owner's window handle. For more info, and code examples, see Display WinRT UI objects that depend on CoreWindow.

public ref class LauncherOptions sealed : ILauncherViewOptions

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class LauncherOptions final : ILauncherViewOptions

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class LauncherOptions : ILauncherViewOptions

function LauncherOptions()

Public NotInheritable Class LauncherOptions
Implements ILauncherViewOptions

Inheritance

Object Platform::Object IInspectable LauncherOptions

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

ILauncherViewOptions

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

See the code example in the LaunchUriAsync(Uri, LauncherOptions) topic.

Remarks

Version history

Windows version	SDK version	Value added
1607	14393	IgnoreAppUriHandlers
1703	15063	LimitPickerToCurrentAppAndAppUriHandlers

Constructors

LauncherOptions()

Creates and initializes a new instance of the launcher options object. In a desktop app, before using an instance of this class in a way that displays UI, you'll need to associate the object with its owner's window handle. For more info, and code examples, see Display WinRT UI objects that depend on CoreWindow.

Properties

ContentType	Gets or sets the content type that is associated with a URI that represents a file on the network.
DesiredRemainingView	Launch a target app and have the currently running source app remain on the screen by sharing the space equally with the target app or by taking up more or less space than the target app.
DisplayApplicationPicker	Gets or sets a value that indicates whether to display the Open With dialog whenever the association launching API is called.
FallbackUri	Gets or sets a value that represents a URI that the user should be taken to in the browser if no app exists to handle the file type or URI.
IgnoreAppUriHandlers	Indicates whether to ignore handlers that can handle http(s) schemes (such as browsers). Instead, launch will fall back to the default browser.
LimitPickerToCurrentAppAndAppUriHandlers	Gets or sets whether to limit the picker for the launcher to the current app and its associated URI handlers.
NeighboringFilesQuery	Enables an app to access files that are related to the file used to activate the app.
PreferredApplicationDisplayName	Gets or sets a value that represents the display name of the app in the store that the user should install if no app exists to handle the file type or URI.
PreferredApplicationPackageFamilyName	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.
TargetApplicationPackageFamilyName	The package family name of the target package that should be used to launch a file or URI. This property is optional.
TreatAsUntrusted	Gets or sets a value that indicates whether the system should display a warning that the file or URI is potentially unsafe when starting the app associated with a file or URI.
UI	Gets the user interface (UI) options when starting a default app.

See also

• LaunchFileAsync(IStorageFile, LauncherOptions)
• LaunchUriAsync(Uri, LauncherOptions)
• Association launching sample
• Launch the default app for a file
• Launch the default app for a URI
• Guidelines for file types and URIs