DataPackage Clase

Definición

Espacio de nombres:

Windows.ApplicationModel.DataTransfer

Contiene los datos que un usuario desea intercambiar con otra aplicación.

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

Herencia

Object Platform::Object IInspectable DataPackage

Atributos

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Requisitos de Windows

Familia de dispositivos	Windows 10 (se introdujo en la versión 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (se introdujo en la versión v1.0)

Ejemplos

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

Comentarios

Durante una operación de recurso compartido, la aplicación de origen coloca los datos que se comparten en un objeto DataPackage y envía ese objeto a la aplicación de destino para su procesamiento. La clase DataPackage incluye varios métodos para admitir los siguientes formatos predeterminados: text, Rtf, Html, Bitmap y StorageItems. También tiene métodos para admitir formatos de datos personalizados. Para usar estos formatos, tanto la aplicación de origen como la aplicación de destino ya deben tener en cuenta que el formato personalizado existe.

Las aplicaciones de origen tienen la opción de usar SetDataProvider para asignar un delegado a un DataPackage, en lugar de proporcionar los datos inmediatamente. Este proceso es útil cuando la aplicación de origen admite un formato determinado, pero no quiere generar los datos a menos que la aplicación de destino solicite los datos. Por ejemplo, una aplicación de origen podría admitir una variedad de formatos de imagen para compartir fotos. En lugar de crear varias copias de cada imagen con estos formatos, la aplicación de origen puede usar un delegado al que se llama cuando la aplicación de destino solicita un tipo de formato específico.

Las aplicaciones de destino pueden usar el objeto DataPackageView para adquirir los datos que se comparten. Además, estas aplicaciones pueden usar la propiedad AvailableFormats para identificar qué formatos admite DataPackageView o usar el método Contains para consultar un formato específico.

Windows Phone 8

Esta API solo se admite en aplicaciones nativas.

Historial de versiones

Versión de Windows	Versión del SDK	Valor agregado
1703	15063	ShareCompleted
2004	19041	ShareCanceled

Constructores

DataPackage()

Constructor que crea un nuevo DataPackage.

Propiedades

Properties	Permite obtener y establecer propiedades como el título del contenido que se comparte.
RequestedOperation	Especifica dataPackageOperation (none, move, copy o link) para la operación.
ResourceMap	Asigna un URI a un archivo. Se usa para asegurarse de que el contenido al que se hace referencia (como una imagen) en el contenido HTML se agrega al DataPackage.

Métodos

GetView()	Devuelve un objeto DataPackageView . Este objeto es una copia de solo lectura del objeto DataPackage .
SetApplicationLink(Uri)	Establece el vínculo de aplicación que contiene un DataPackage .
SetBitmap(RandomAccessStreamReference)	Establece la imagen de mapa de bits contenida en DataPackage.
SetData(String, Object)	Establece los datos contenidos en el DataPackage en un formato RandomAccessStream .
SetDataProvider(String, DataProviderHandler)	Establece un delegado para controlar las solicitudes de la aplicación de destino.
SetHtmlFormat(String)	Agrega contenido HTML al DataPackage.
SetRtf(String)	Establece el contenido del formato de texto enriquecido (RTF) que se encuentra en un DataPackage.
SetStorageItems(IIterable<IStorageItem>)	Establece los archivos y carpetas contenidos en un DataPackage.
SetStorageItems(IIterable<IStorageItem>, Boolean)	Agrega archivos y carpetas a un DataPackage.
SetText(String)	Establece el texto que contiene un DataPackage .
SetUri(Uri)	Nota: SetUri puede modificarse o no estar disponible para las versiones después de Windows 8.1. En su lugar, use ApplicationLink o WebLink. Establece el identificador uniforme de recursos (URI) que se encuentra en el DataPackage.
SetWebLink(Uri)	Establece el vínculo web que contiene un DataPackage .

Eventos

Destroyed	Se produce cuando se destruye DataPackage .
OperationCompleted	Se produce cuando se completa una operación de pegado.
ShareCanceled	Se genera cuando se cancela un recurso compartido.
ShareCompleted	Evento que se desencadena cuando se completa un recurso compartido. Los recursos compartidos se pueden enviar a una aplicación, un proveedor o un contacto.

Consulte también

• Ejemplo del Portapapeles (Windows 10)
• Ejemplo de aplicación de origen de contenido compartido (Windows 10)