DataPackage Classe

  • Referência

Definição

Namespace:
Windows.ApplicationModel.DataTransfer
Editar

Contém os dados que um usuário deseja trocar com outro aplicativo.

public ref class DataPackage sealed
/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class DataPackage final
/// [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")]
class DataPackage final
/// [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.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class DataPackage
[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")]
public sealed class DataPackage
[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
Herança
Object Platform::Object IInspectable DataPackage
Atributos
ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Requisitos do Windows

Família de dispositivos
Windows 10 (introduzida na 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduzida na v1.0)

Exemplos

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

Comentários

Durante uma operação de compartilhamento, o aplicativo de origem coloca os dados sendo compartilhados em um objeto DataPackage e envia esse objeto para o aplicativo de destino para processamento. A classe DataPackage inclui vários métodos para dar suporte aos seguintes formatos padrão: text, Rtf, Html, Bitmap e StorageItems. Ele também tem métodos para dar suporte a formatos de dados personalizados. Para usar esses formatos, o aplicativo de origem e o aplicativo de destino já devem estar cientes de que o formato personalizado existe.

Os aplicativos de origem têm a opção de usar SetDataProvider para atribuir um delegado a um DataPackage, em vez de fornecer os dados imediatamente. Esse processo é útil quando o aplicativo de origem dá suporte a um determinado formato, mas não deseja gerar os dados, a menos que o aplicativo de destino solicite os dados. Por exemplo, um aplicativo de origem pode dar suporte a uma variedade de formatos de imagem para compartilhar fotos. Em vez de criar várias cópias de cada imagem usando esses formatos, o aplicativo de origem pode usar um delegado que é chamado quando o aplicativo de destino solicita um tipo de formato específico.

Os aplicativos de destino podem usar o objeto DataPackageView para adquirir os dados que estão sendo compartilhados. Além disso, esses aplicativos podem usar a propriedade AvailableFormats para identificar quais formatos o DataPackageView dá suporte ou usar o método Contains para consultar um formato específico.

Windows Phone 8

Essa API tem suporte apenas em aplicativos nativos.

Histórico de versão

Versão do Windows Versão do SDK Valor adicionado
1703 15063 ShareCompleted
2004 19041 ShareCanceled

Construtores

DataPackage()

Construtor que cria um novo DataPackage.

Propriedades

Properties

Permite que você obtenha e defina propriedades como o título do conteúdo que está sendo compartilhado.
RequestedOperation

Especifica o DataPackageOperation (nenhum, mover, copiar ou vincular) para a operação.
ResourceMap

Mapeia um URI para um arquivo. Usado para garantir que o conteúdo referenciado (como uma imagem) no conteúdo HTML seja adicionado ao DataPackage.

Métodos

GetView()

Retorna um objeto DataPackageView . Este objeto é uma cópia somente leitura do objeto DataPackage .
SetApplicationLink(Uri)

Define o link do aplicativo que um DataPackage contém.
SetBitmap(RandomAccessStreamReference)

Define a imagem de bitmap contida no DataPackage.
SetData(String, Object)

Define os dados contidos no DataPackage em um formato RandomAccessStream .
SetDataProvider(String, DataProviderHandler)

Define um delegado para manipular solicitações do aplicativo de destino.
SetHtmlFormat(String)

Adiciona conteúdo HTML ao DataPackage.
SetRtf(String)

Define o conteúdo rtf (rich text format) contido em um DataPackage.
SetStorageItems(IIterable<IStorageItem>)

Define os arquivos e pastas contidos em um DataPackage.
SetStorageItems(IIterable<IStorageItem>, Boolean)

Adiciona arquivos e pastas a um DataPackage.
SetText(String)

Define o texto que um DataPackage contém.
SetUri(Uri)

Observação

SetUri pode ser alterado ou indisponível para versões após Windows 8.1. Em vez disso, use ApplicationLink ou WebLink.

Define o URI (Uniform Resource Identifier) contido no DataPackage.
SetWebLink(Uri)

Define o link da Web que um DataPackage contém.

Eventos

Destroyed

Ocorre quando o DataPackage é destruído.
OperationCompleted

Ocorre quando uma operação de colagem é concluída.
ShareCanceled

Gerado quando um compartilhamento é cancelado.
ShareCompleted

Um evento que é disparado quando um compartilhamento é concluído. Os compartilhamentos podem ser enviados para um aplicativo, um provedor ou um contato.

Aplica-se a

Confira também