FileActivatedEventArgs Class

Definition

Namespace:

Windows.ApplicationModel.Activation

Provides data when an app is activated because it is the app associated with a file.

JavaScript This type appears as WebUIFileActivatedEventArgs.

public ref class FileActivatedEventArgs sealed : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IFileActivatedEventArgsWithCallerPackageFamilyName, IFileActivatedEventArgsWithNeighboringFiles, IViewSwitcherProvider

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class FileActivatedEventArgs final : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IFileActivatedEventArgsWithCallerPackageFamilyName, IFileActivatedEventArgsWithNeighboringFiles, IViewSwitcherProvider

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class FileActivatedEventArgs : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IFileActivatedEventArgsWithCallerPackageFamilyName, IFileActivatedEventArgsWithNeighboringFiles, IViewSwitcherProvider

Public NotInheritable Class FileActivatedEventArgs
Implements IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IFileActivatedEventArgsWithCallerPackageFamilyName, IFileActivatedEventArgsWithNeighboringFiles, IViewSwitcherProvider

Inheritance

Object Platform::Object IInspectable FileActivatedEventArgs

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Implements

IActivatedEventArgs IApplicationViewActivatedEventArgs IFileActivatedEventArgs IFileActivatedEventArgsWithCallerPackageFamilyName IFileActivatedEventArgsWithNeighboringFiles IViewSwitcherProvider IActivatedEventArgsWithUser

Windows requirements

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

Examples

The OnFileActivated event handler on the Application object receives all file activation events.

protected override void OnFileActivated(FileActivatedEventArgs args)
{
       // TODO: Handle file activation

       // The number of files received is args.Files.Size
       // The first file is args.Files[0].Name
}

Private Sub OnFileActivated(ByVal args As Windows.ApplicationModel.Activation.FileActivatedEventArgs)
      ' TODO: Handle file activation

      ' The number of files received is args.Files.Size
      ' The first file is args.Files(0).Name
End Sub

void App::OnFileActivated(Windows::ApplicationModel::Activation::FileActivatedEventArgs const& /* args */)
{
    // TODO: Handle file activation.

    // The number of files received is args.Files().Size().
    // The first file is args.Files().GetAt(0).Name().
}

void App::OnFileActivated(Windows::ApplicationModel::Activation::FileActivatedEventArgs^ args)
{
       // TODO: Handle file activation

       // The number of files received is args->Files->Size
       // The first file is args->Files->GetAt(0)->Name
}

Remarks

This object is accessed when you implement an event handler to respond to Activated events when ActivationKind is File.

UWP app using C++, C#, or Visual Basic typically implement activation points by overriding methods of the Application object. The default template app.xaml code-behind files always include an override for OnLaunched, but defining overrides for other activation points such as OnFileActivated is up to your app code.

All Application overrides involved in an activation scenario should call Window.Activate in their implementations.

Note that when your app is activated for the file contract you must access the data using the StorageFile objects passed to your app through the Files property. You should not attempt to access the path of the file since your app may not have permission to the file’s location.

Version history

Windows version	SDK version	Value added
1607	14393	User

Properties

CallerPackageFamilyName	The package family name of the app that launched your app.
CurrentlyShownApplicationViewId	Gets the identifier for the currently shown app view.
Files	Gets the files for which the app was activated.
Kind	Gets the activation type.
NeighboringFilesQuery	Gets the neighboring files of the files for which the app was activated.
PreviousExecutionState	Gets the execution state of the app before it was activated.
SplashScreen	Gets the splash screen object that provides information about the transition from the splash screen to the activated app.
User	Gets the user that the app was activated for.
Verb	Gets the action associated with the activated file.
ViewSwitcher	Provides the object that allows you to set the view for the application.

See also

• Windows.Storage
• Activated
• OnFileActivated(FileActivatedEventArgs)
• Association launching sample
• Handle file activation
• Guidelines for file types and URIs
• Association launching sample (Windows 10)