DataPackagePropertySet Class

Reference

Definition

Namespace:: Windows.ApplicationModel.DataTransfer

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Defines a set of properties to use with a DataPackage object.

public ref class DataPackagePropertySet sealed : IIterable<IKeyValuePair<Platform::String ^, Platform::Object ^> ^>, IMap<Platform::String ^, Platform::Object ^>

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class DataPackagePropertySet final : IIterable<IKeyValuePair<winrt::hstring, IInspectable const&>>, IMap<winrt::hstring, IInspectable const&>

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class DataPackagePropertySet : IDictionary<string,object>, IEnumerable<KeyValuePair<string,object>>

Public NotInheritable Class DataPackagePropertySet
Implements IDictionary(Of String, Object), IEnumerable(Of KeyValuePair(Of String, Object))

Inheritance: Object Platform::Object IInspectable DataPackagePropertySet

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Implements: IDictionary<String,Object> IMap<Platform::String,Platform::Object> IMap<winrt::hstring,IInspectable> IIterable<IKeyValuePair<K,V>> IEnumerable<KeyValuePair<K,V>> IEnumerable<KeyValuePair<String,Object>> IIterable<IKeyValuePair<Platform::String,Platform::Object>> IIterable<IKeyValuePair<winrt::hstring,IInspectable>>

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

In addition to the content being shared, each instance of a DataPackage object supports a set of properties. Target apps can use these properties to learn more about the content of the DataPackage.

This class directly supports several default properties, such as a thumbnail, a title, and a description. You can also create your own custom properties by using the Insert method or one of the Add methods. Target apps can access specific properties through the Lookup method.

Collection member lists

For JavaScript, DataPackagePropertySet supports using an index to access items.

Version history

Windows version	SDK version	Value added
1803	17134	ContentSourceUserActivityJson

Properties

ApplicationListingUri	Gets or sets the Uniform Resource Identifier (URI) of the app's location in the Windows Store.
ApplicationName	Gets or sets the name of the app that created the DataPackage object.
ContentSourceApplicationLink	Gets or sets the application link to the content from the source app.
ContentSourceUserActivityJson	Gets or sets the UserActivity in serialized JSON format to be shared with another app.
ContentSourceWebLink	Provides a web link to shared content that's currently displayed in the app.
Description	Gets or sets text that describes the contents of the DataPackage.
EnterpriseId	Gets or sets the enterprise identity (see Enterprise data protection).
FileTypes	Specifies a vector object that contains the types of files stored in the DataPackage object.
LogoBackgroundColor	Gets or sets a background color for the sharing app's Square30x30Logo.
PackageFamilyName	Gets or sets the package family name of the source app.
Size	Gets the number of items that are contained in the property set.
Square30x30Logo	Gets or sets the source app's logo.
Thumbnail	Gets or sets a thumbnail image for the DataPackage.
Title	Gets or sets the text that displays as a title for the contents of the DataPackage object.

Methods

Clear()	Removes all items from the property set.
First()	Returns an iterator to enumerate the items in the property set.
GetView()	Gets an immutable view of the property set.
HasKey(String)	Indicates whether the DataPackagePropertySet object contains a specific property.
Insert(String, Object)	Adds a property to the DataPackagePropertySet object.
Lookup(String)	Retrieves the value of a specific property.
Remove(String)	Removes an item from the property set.

Applies to

Share via