ProtocolActivatedEventArgs Classe

Définition

Espace de noms:

Windows.ApplicationModel.Activation

Fournit des données lorsqu’une application est activée, car il s’agit de l’application associée à un nom de schéma d’URI.

Javascript Ce type apparaît sous la forme WebUIProtocolActivatedEventArgs.

public ref class ProtocolActivatedEventArgs sealed : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IViewSwitcherProvider

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ProtocolActivatedEventArgs final : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IViewSwitcherProvider

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ProtocolActivatedEventArgs : IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IViewSwitcherProvider

Public NotInheritable Class ProtocolActivatedEventArgs
Implements IActivatedEventArgsWithUser, IApplicationViewActivatedEventArgs, IProtocolActivatedEventArgs, IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData, IViewSwitcherProvider

Héritage

Object Platform::Object IInspectable ProtocolActivatedEventArgs

Attributs

ContractVersionAttribute MarshalingBehaviorAttribute

Implémente

IActivatedEventArgs IApplicationViewActivatedEventArgs IProtocolActivatedEventArgs IProtocolActivatedEventArgsWithCallerPackageFamilyNameAndData IViewSwitcherProvider IActivatedEventArgsWithUser

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v1.0)

Exemples

Le gestionnaire d’événements OnActivated reçoit tous les événements d’activation. La propriété indique le type d’événement d’activation. Cet exemple est configuré pour gérer les événements d’activation d’URI .

public partial class App
{
   protected override void OnActivated(IActivatedEventArgs args)
   {
      if (args.Kind == ActivationKind.Protocol)
      {
         ProtocolActivatedEventArgs eventArgs = args as ProtocolActivatedEventArgs;

         // TODO: Handle URI activation
         // The received URI is eventArgs.Uri.AbsoluteUri
      }
   }
}

Private Sub OnFileActivated(ByVal args As Windows.ApplicationModel.Activation.IActivatedEventArgs)
   If args.Kind = ActivationKind.Protocol Then
      ProtocolActivatedEventArgs eventArgs = args As ProtocolActivatedEventArgs

      ' TODO: Handle URI activation
      ' The received URI is eventArgs.Uri.AbsoluteUri
   End If
End Sub

void App::OnActivated(Windows::ApplicationModel::Activation::IActivatedEventArgs const& args)
{
    if (args.Kind() == Windows::ApplicationModel::Activation::ActivationKind::Protocol)
    {
        auto eventArgs{ args.as<Windows::ApplicationModel::Activation::ProtocolActivatedEventArgs>() };

        // TODO: Handle URI activation.
        // The received URI is eventArgs.Uri().RawUri().
    }
}

void App::OnActivated(Windows::ApplicationModel::Activation::IActivatedEventArgs^ args)
{
   if (args->Kind == Windows::ApplicationModel::Activation::ActivationKind::Protocol)
   {
      Windows::ApplicationModel::Activation::ProtocolActivatedEventArgs^ eventArgs = 
          dynamic_cast<Windows::ApplicationModel::Activation::ProtocolActivatedEventArgs^>(args);

      // TODO: Handle URI activation  
      // The received URI is eventArgs->Uri->RawUri
   } 
}

Remarques

Cet objet est accessible lorsque vous implémentez un gestionnaire d’événements pour répondre aux événements Activés lorsque ActivationKind est Protocol.

L’application UWP utilisant C++, C# ou Visual Basic implémente généralement des points d’activation en remplaçant les méthodes de l’objet Application . Les fichiers code-behind de modèle par défaut app.xaml incluent toujours un remplacement pour OnLaunched, mais la définition de remplacements pour d’autres points d’activation tels que OnActivated dépend du code de votre application. Si ActivationKind a la valeur Protocol , le IActivatedEventArgs de type interface d’OnActivated peut être converti en ProtocolActivatedEventArgs.

Tous les remplacements d’application impliqués dans un scénario d’activation doivent appeler Window.Activate dans leurs implémentations.

Historique des versions

Version de Windows	Version du SDK	Valeur ajoutée
1607	14393	Utilisateur

Propriétés

CallerPackageFamilyName	Obtient le nom de la famille de packages de l’application qui a activé l’application actuelle.
CurrentlyShownApplicationViewId	Obtient l’identificateur de la vue d’application actuellement affichée.
Data	Données reçues de l’application qui a activé l’application actuelle.
Kind	Obtient le type d’activation.
PreviousExecutionState	Obtient l’état d’exécution de l’application avant son activation.
SplashScreen	Obtient l’objet d’écran de démarrage qui fournit des informations sur la transition de l’écran de démarrage à l’application activée.
Uri	Obtient l’URI (Uniform Resource Identifier) pour lequel l’application a été activée.
User	Obtient l’utilisateur pour lequel l’application a été activée.
ViewSwitcher	Obtient l’objet sélecteur de vue qui vous permet de définir la vue pour l’application.

Voir aussi

• Activated
• OnActivated(IActivatedEventArgs)
• Uri
• Exemple de lancement d’association
• Exemple de gestion des actions de contact
• Gérer l’activation des URI
• Démarrage rapide : Gestion des actions de contact
• Recommandations en matière de types de fichiers et d’URI
• Exemple de lancement d’association (Windows 10)