DataPackage Klasse

Definition

Namespace:

Windows.ApplicationModel.DataTransfer

Enthält die Daten, die ein Benutzer mit einer anderen App austauschen möchte.

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

Vererbung

Object Platform::Object IInspectable DataPackage

Attribute

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows-Anforderungen

Gerätefamilie	Windows 10 (eingeführt in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (eingeführt in v1.0)

Beispiele

//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!");
}

Hinweise

Während eines Freigabevorgangs platziert die Quell-App die freigegebenen Daten in einem DataPackage-Objekt und sendet dieses Objekt zur Verarbeitung an die Ziel-App. Die DataPackage-Klasse enthält eine Reihe von Methoden zur Unterstützung der folgenden Standardformate: text, Rtf, Html, Bitmap und StorageItems. Es verfügt auch über Methoden zur Unterstützung benutzerdefinierter Datenformate. Um diese Formate verwenden zu können, müssen sowohl die Quell-App als auch die Ziel-App bereits wissen, dass das benutzerdefinierte Format vorhanden ist.

Quell-Apps haben die Möglichkeit, SetDataProvider zu verwenden, um einem DataPackage einen Delegaten zuzuweisen, anstatt die Daten sofort bereitzustellen. Dieser Prozess ist nützlich, wenn die Quell-App ein bestimmtes Format unterstützt, die Daten jedoch nicht generieren möchte, es sei denn, die Ziel-App fordert die Daten an. Beispielsweise kann eine Quell-App eine Vielzahl von Bildformaten zum Freigeben von Fotos unterstützen. Anstatt mehrere Kopien jedes Bilds mit diesen Formaten zu erstellen, kann die Quell-App einen Delegaten verwenden, der aufgerufen wird, wenn die Ziel-App einen bestimmten Formattyp anfordert.

Ziel-Apps können das DataPackageView-Objekt verwenden, um die freigegebenen Daten zu erfassen. Darüber hinaus können diese Apps die AvailableFormats-Eigenschaft verwenden, um zu identifizieren, welche Formate von DataPackageView unterstützt werden, oder die Contains-Methode verwenden, um ein bestimmtes Format abzufragen.

Windows Phone 8

Diese API wird nur in nativen Apps unterstützt.

Versionsverlauf

Windows-Version	SDK-Version	Wertschöpfung
1703	15063	ShareCompleted
2004	19041	ShareCanceled

Konstruktoren

DataPackage()

Konstruktor, der ein neues DataPackage erstellt.

Eigenschaften

Properties	Ermöglicht das Abrufen und Festlegen von Eigenschaften wie dem Titel des freigegebenen Inhalts.
RequestedOperation	Gibt die DataPackageOperation (none, move, copy oder link) für den Vorgang an.
ResourceMap	Ordnet einen URI einer Datei zu. Wird verwendet, um sicherzustellen, dass inhalte (z. B. ein Bild) in HTML-Inhalten dem DataPackage hinzugefügt werden.

Methoden

GetView()	Gibt ein DataPackageView-Objekt zurück. Dieses Objekt ist eine schreibgeschützte Kopie des DataPackage-Objekts .
SetApplicationLink(Uri)	Legt den Anwendungslink fest, den ein DataPackage enthält.
SetBitmap(RandomAccessStreamReference)	Legt das Bitmapbild fest, das im DataPackage enthalten ist.
SetData(String, Object)	Legt die im DataPackage enthaltenen Daten in einem RandomAccessStream-Format fest.
SetDataProvider(String, DataProviderHandler)	Legt einen Delegaten fest, um Anforderungen von der Ziel-App zu behandeln.
SetHtmlFormat(String)	Fügt dem DataPackage HTML-Inhalt hinzu.
SetRtf(String)	Legt den RTF-Inhalt (Rich Text Format) fest, der in einem DataPackage enthalten ist.
SetStorageItems(IIterable<IStorageItem>)	Legt die Dateien und Ordner fest, die in einem DataPackage enthalten sind.
SetStorageItems(IIterable<IStorageItem>, Boolean)	Fügt Einem DataPackage Dateien und Ordner hinzu.
SetText(String)	Legt den Text fest, den ein DataPackage enthält.
SetUri(Uri)	Hinweis SetUri kann für Releases nach Windows 8.1 geändert oder nicht mehr verfügbar sein. Verwenden Sie stattdessen ApplicationLink oder WebLink. Legt den URI (Uniform Resource Identifier) fest, der im DataPackage enthalten ist.
SetWebLink(Uri)	Legt den Weblink fest, den ein DataPackage enthält.

Ereignisse

Destroyed	Tritt auf, wenn das DataPackage zerstört wird.
OperationCompleted	Tritt auf, wenn ein Einfügevorgang abgeschlossen ist.
ShareCanceled	Wird ausgelöst, wenn eine Freigabe abgebrochen wird.
ShareCompleted	Ein Ereignis, das ausgelöst wird, wenn eine Freigabe abgeschlossen ist. Freigaben können an eine App, einen Anbieter oder einen Kontakt gesendet werden.

Weitere Informationen

• Zwischenablagebeispiel (Windows 10)
• Beispiel für die Freigabe der Quell-App für Inhalte (Windows 10)