DataPackage Класс

Определение

Пространство имен:

Windows.ApplicationModel.DataTransfer

Содержит данные, которыми пользователь хочет обмениваться с другим приложением.

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

Наследование

Object Platform::Object IInspectable DataPackage

Атрибуты

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Требования к Windows

Семейство устройств	Windows 10 (появилось в 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (появилось в v1.0)

Примеры

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

Комментарии

Во время операции общего доступа исходное приложение помещает данные, к которым предоставлен общий доступ, в объект DataPackage и отправляет этот объект целевому приложению для обработки. Класс DataPackage включает ряд методов для поддержки следующих форматов по умолчанию: text, Rtf, Html, Bitmap и StorageItems. Он также содержит методы для поддержки пользовательских форматов данных. Чтобы использовать эти форматы, исходное и целевое приложение уже должны знать, что пользовательский формат существует.

Исходные приложения могут использовать SetDataProvider для назначения делегата DataPackage вместо немедленного предоставления данных. Этот процесс полезен, если исходное приложение поддерживает заданный формат, но не хочет создавать данные, если целевое приложение не запрашивает данные. Например, исходное приложение может поддерживать различные форматы изображений для общего доступа к фотографиям. Вместо создания нескольких копий каждого изображения с использованием этих форматов исходное приложение может использовать делегат, который вызывается, когда целевое приложение запрашивает определенный тип формата.

Целевые приложения могут использовать объект DataPackageView для получения данных, к которым предоставляется доступ. Кроме того, эти приложения могут использовать свойство AvailableFormats для определения форматов , поддерживаемых DataPackageView , или использовать метод Contains для запроса определенного формата.

Windows Phone 8

Этот API поддерживается только в собственных приложениях.

Журнал версий

Версия Windows	Версия пакета SDK	Добавленная стоимость
1703	15063	ShareCompleted
2004	19041	ShareCanceled

Конструкторы

DataPackage()

Конструктор, создающий новый DataPackage.

Свойства

Properties	Позволяет получать и задавать свойства, такие как заголовок содержимого, к которым предоставляется доступ.
RequestedOperation	Указывает DataPackageOperation (нет, перемещение, копирование или ссылка) для операции.
ResourceMap	Сопоставляет универсальный код ресурса (URI) с файлом. Используется для добавления в DataPackage указанного содержимого (например, изображения) в HTML-содержимом.

Методы

GetView()	Возвращает объект DataPackageView . Этот объект является доступной только для чтения копией объекта DataPackage .
SetApplicationLink(Uri)	Задает ссылку приложения, содержащуюся в DataPackage .
SetBitmap(RandomAccessStreamReference)	Задает растровое изображение, содержащееся в DataPackage.
SetData(String, Object)	Задает данные, содержащиеся в DataPackage , в формате RandomAccessStream .
SetDataProvider(String, DataProviderHandler)	Задает делегат для обработки запросов из целевого приложения.
SetHtmlFormat(String)	Добавляет HTML-содержимое в DataPackage.
SetRtf(String)	Задает содержимое RTF, содержащееся в DataPackage.
SetStorageItems(IIterable<IStorageItem>)	Задает файлы и папки, содержащиеся в DataPackage.
SetStorageItems(IIterable<IStorageItem>, Boolean)	Добавляет файлы и папки в DataPackage.
SetText(String)	Задает текст, содержащийся в DataPackage .
SetUri(Uri)	Примечание SetUri может быть изменен или недоступен для выпусков после Windows 8.1. Вместо этого используйте ApplicationLink или WebLink. Задает универсальный код ресурса (URI), содержащийся в DataPackage.
SetWebLink(Uri)	Задает веб-ссылку, содержащуюся в DataPackage .

События

Destroyed	Происходит при уничтожении DataPackage .
OperationCompleted	Происходит при завершении операции вставки.
ShareCanceled	Возникает при отмене общего ресурса.
ShareCompleted	Событие, которое активируется при завершении общей папки. Общие папки можно отправлять приложению, поставщику или контакту.

См. также раздел

• Пример буфера обмена (Windows 10)
• Пример совместного использования исходного приложения содержимого (Windows 10)