DataPackage Classe

Définition

Espace de noms:

Windows.ApplicationModel.DataTransfer

Contient les données qu’un utilisateur souhaite échanger avec une autre application.

public ref class DataPackage sealed

/// [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 DataPackage final

[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 DataPackage

function DataPackage()

Public NotInheritable Class DataPackage

Héritage

Object Platform::Object IInspectable DataPackage

Attributs

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

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

//To see this code in action, add a call to ShareSourceLoad to your constructor or other
//initializing function.
private void ShareSourceLoad()
{
    DataTransferManager dataTransferManager = DataTransferManager.GetForCurrentView();
    dataTransferManager.DataRequested += new TypedEventHandler<DataTransferManager, DataRequestedEventArgs>(this.DataRequested);
}

private void DataRequested(DataTransferManager sender, DataRequestedEventArgs e)
{
    DataRequest request = e.Request;
    request.Data.Properties.Title = "Share Text Example";
    request.Data.Properties.Description = "An example of how to share text.";
    request.Data.SetText("Hello World!");
}

Remarques

Pendant une opération de partage, l’application source place les données partagées dans un objet DataPackage et envoie cet objet à l’application cible pour traitement. La classe DataPackage comprend un certain nombre de méthodes pour prendre en charge les formats par défaut suivants : text, Rtf, Html, Bitmap et StorageItems. Il a également des méthodes pour prendre en charge les formats de données personnalisés. Pour utiliser ces formats, l’application source et l’application cible doivent déjà savoir que le format personnalisé existe.

Les applications sources ont la possibilité d’utiliser SetDataProvider pour affecter un délégué à un DataPackage, au lieu de fournir les données immédiatement. Ce processus est utile lorsque l’application source prend en charge un format donné, mais ne souhaite pas générer les données, sauf si l’application cible demande les données. Par exemple, une application source peut prendre en charge divers formats d’image pour le partage de photos. Au lieu de créer plusieurs copies de chaque image à l’aide de ces formats, l’application source peut utiliser un délégué appelé lorsque l’application cible demande un type de format spécifique.

Les applications cibles peuvent utiliser l’objet DataPackageView pour acquérir les données partagées. En outre, ces applications peuvent utiliser la propriété AvailableFormats pour identifier les formats pris en charge par DataPackageView , ou utiliser la méthode Contains pour interroger un format spécifique.

Windows Phone 8

Cette API est prise en charge uniquement dans les applications natives.

Historique des versions

Version de Windows	Version du SDK	Valeur ajoutée
1703	15063	ShareCompleted
2004	19041	ShareCanceled

Constructeurs

DataPackage()

Constructeur qui crée un DataPackage.

Propriétés

Properties	Vous permet d’obtenir et de définir des propriétés telles que le titre du contenu partagé.
RequestedOperation	Spécifie le DataPackageOperation (aucun, déplacement, copie ou lien) pour l’opération.
ResourceMap	Mappe un URI à un fichier. Permet de s’assurer que le contenu référencé (tel qu’une image) dans le contenu HTML est ajouté au DataPackage.

Méthodes

GetView()	Renvoie un objet DataPackageView . Cet objet est une copie en lecture seule de l’objet DataPackage .
SetApplicationLink(Uri)	Définit le lien d’application qu’un DataPackage contient.
SetBitmap(RandomAccessStreamReference)	Définit l’image bitmap contenue dans le DataPackage.
SetData(String, Object)	Définit les données contenues dans le DataPackage dans un format RandomAccessStream .
SetDataProvider(String, DataProviderHandler)	Définit un délégué pour gérer les requêtes de l’application cible.
SetHtmlFormat(String)	Ajoute du contenu HTML au DataPackage.
SetRtf(String)	Définit le contenu RTF (Rich Text Format) contenu dans un DataPackage.
SetStorageItems(IIterable<IStorageItem>)	Définit les fichiers et dossiers contenus dans un DataPackage.
SetStorageItems(IIterable<IStorageItem>, Boolean)	Ajoute des fichiers et des dossiers à un DataPackage.
SetText(String)	Définit le texte qu’un DataPackage contient.
SetUri(Uri)	Notes SetUri peut être modifié ou indisponible pour les versions après Windows 8.1. Utilisez plutôt ApplicationLink ou WebLink. Définit l’URI (Uniform Resource Identifier) contenu dans le DataPackage.
SetWebLink(Uri)	Définit le lien web qu’un DataPackage contient.

Événements

Destroyed	Se produit lorsque le DataPackage est détruit.
OperationCompleted	Se produit lorsqu’une opération de collage est terminée.
ShareCanceled	Déclenché lors de l’annulation d’un partage.
ShareCompleted	Événement déclenché lorsqu’un partage est terminé. Les partages peuvent être envoyés à une application, à un fournisseur ou à un contact.

Voir aussi

• Exemple de Presse-papiers (Windows 10)
• Exemple d’application de source de contenu (Windows 10)