PropertySet PropertySet PropertySet PropertySet Class

Definition

Represents a property set, which is a set of PropertyValue objects with string keys.

public : sealed class PropertySet : IIterable<IKeyValuePair<Platform::String, Platform::Object>>, IMap<Platform::String, Platform::Object>, IObservableMap<Platform::String, Platform::Object>, IPropertySet
public sealed class PropertySet : IEnumerable<KeyValuePair<String, Object>>, IDictionary<String, Object>, IObservableMap<String, Object>, IPropertySet
Public NotInheritable Class PropertySet Implements IEnumerable<KeyValuePair<String, Object>>, IDictionary<String, Object>, IObservableMap<String, Object>, IPropertySet
var propertySet = new propertySet();
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.FoundationContract (introduced v1)

Remarks

This class implements a map (the IMap; interface) with keys of type String and values of type PropertyValue. The PropertySet type enables various Windows Runtime APIs to return a collection of mixed values that can still be iterated or inspected using the common collection APIs of PropertySet, which match those of IMap;, IDictionary<TKey,TValue>, or JavaScript collection and enumeration techniques, depending on which language your app uses.

PropertyValue is a class that supports a large number of static Create* methods that create a deliberately untyped value from an input that's typically a value type or primitive (Boolean, numbers and so on) or an array of those values. Once one of the static PropertyValue methods is called, its return value can be treated as a PropertyValue instance (however the Create* methods technically return an Object if you look at the signatures).

However, you don't typically use a PropertySet in a way that requires you to fill the PropertyValue values in the set yourself. Instead, you typically get a filled-in PropertySet as a return value from a Windows Runtime API that's providing a collection where the value types within it might be mixed, but are still related to each other by origin or scenario. For example, the LocalSettings and RoamingSettings values that you get when you retrieve app data are of type ApplicationDataContainer, and each contains a PropertySet as its Values property value. When you interact with app data that's storing settings, you typically get the collection from ApplicationDataContainer.Values. Then you can:

  • iterate over the set using the appropriate iteration syntax
  • use HasKey /ContainsKey to verify the existence of a PropertyValue in the set
  • use Lookup or the Item indexer to retrieve an item once you know it exists

For scenarios like working with app data, when you have a PropertySet you have it by reference, so if you add items to the PropertySet using Add/Insert these items will be added to the app data, and removing items removes them from app data. All such changes are then shared through the app data mechanisms, if they're made to the RoamingSettings.

There are other Windows Runtime APIs that use a PropertySet value as a direct value rather than wrapped in another class like ApplicationDataContainer. For example, CoreApplication.Properties returns a PropertySet.

Various properties that report info from media and devices use PropertySet, for example PlayToReceiver.Properties. However, there are other media/devices property sets that don't use PropertySet and instead use MediaPropertySet, because the identifier for those properties is better represented when keyed as a GUID rather than a string.

In many cases where a Windows Runtime API uses a PropertySet as a value, it's actually shown as IPropertySet in the signatures. PropertySet can be considered the practical implementation of IPropertySet that's ready for use by app code. JavaScript code can treat any IPropertySet value as if it implemented the PropertySet prototypes.

Collection member lists

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

Constructors

PropertySet() PropertySet() PropertySet() PropertySet()

Creates and initializes a new instance of the property set.

public : PropertySet()
public PropertySet()
Public Sub New()
var propertySet = new propertySet();

Properties

Item[TKey] Item[TKey] Item[TKey] Item[TKey]

Gets or sets the element with the specified key.

This member is not implemented in C++
TValue this[TKey key] { get; set; }
Property Item(key As TKey) As TValue
TValue this[TKey key] { get; set; }
Parameters
key
TKey TKey TKey TKey

The key of the element to get or set.

Value
TValue TValue TValue TValue

The element with the specified key.

Exceptions

key is null.

The property is retrieved and key is not found.

The property is set and the System.Collections.Generic.IDictionary`2 is read-only.

Keys Keys Keys Keys

Gets an System.Collections.Generic.ICollection`1 containing the keys of the System.Collections.Generic.IDictionary`2.

This member is not implemented in C++
ICollection<TKey> Keys { get; }
ReadOnly Property Keys As ICollection(Of TKey)
ICollection<TKey> Keys { get; }
Value

An System.Collections.Generic.ICollection`1 containing the keys of the object that implements System.Collections.Generic.IDictionary`2.

Size Size Size Size

Gets the number of items contained in the property set.

public : unsigned int Size { get; }
This member is not implemented in C#
This member is not implemented in VB.Net
var uint = propertySet.size;
Value
unsigned int uint uint uint

The number of items in the property set.

Values Values Values Values

Gets an System.Collections.Generic.ICollection`1 containing the values in the System.Collections.Generic.IDictionary`2.

This member is not implemented in C++
ICollection<TValue> Values { get; }
ReadOnly Property Values As ICollection(Of TValue)
ICollection<TValue> Values { get; }
Value

An System.Collections.Generic.ICollection`1 containing the values in the object that implements System.Collections.Generic.IDictionary`2.

Methods

Add(TKey, TValue) Add(TKey, TValue) Add(TKey, TValue) Add(TKey, TValue)

Adds an element with the provided key and value to the System.Collections.Generic.IDictionary`2.

This member is not implemented in C++
void Add(TKey key, TValue value)
Sub Add(key As TKey, value As TValue)
void Add(TKey key, TValue value)
Parameters
key
TKey TKey TKey TKey

The object to use as the key of the element to add.

value
TValue TValue TValue TValue

The object to use as the value of the element to add.

Exceptions

key is null.

An element with the same key already exists in the System.Collections.Generic.IDictionary`2.

The System.Collections.Generic.IDictionary`2 is read-only.

Clear() Clear() Clear() Clear()

Removes all items from the property set.

public : void Clear()
This member is not implemented in C#
This member is not implemented in VB.Net
propertySet.clear();

ContainsKey(TKey) ContainsKey(TKey) ContainsKey(TKey) ContainsKey(TKey)

Determines whether the System.Collections.Generic.IDictionary`2 contains an element with the specified key.

This member is not implemented in C++
bool ContainsKey(TKey key)
Function ContainsKey(key As TKey) As Boolean
bool ContainsKey(TKey key)
Parameters
key
TKey TKey TKey TKey

The key to locate in the System.Collections.Generic.IDictionary`2.

Returns

true if the System.Collections.Generic.IDictionary`2 contains an element with the key; otherwise, false.

Exceptions

key is null.

First() First() First() First()

Returns an iterator to enumerate the items in the property set.

public : IIterator<IKeyValuePair<Platform::String, Platform::Object>> First()
This member is not implemented in C#
This member is not implemented in VB.Net
var iIterator = propertySet.first();
Returns
IIterator<IKeyValuePair<Platform::String, Platform::Object>> IIterator<KeyValuePair<string, object>> IIterator<KeyValuePair<string, object>> IIterator<KeyValuePair<string, object>>

The iterator. The current position of the iterator is index 0, or the end of the property set if the property set is empty.

GetEnumerator() GetEnumerator() GetEnumerator() GetEnumerator()

Returns an enumerator that iterates through the collection.

This member is not implemented in C++
IEnumerator<T> GetEnumerator()
Function GetEnumerator As IEnumerator(Of T)
IEnumerator<T> GetEnumerator()
Returns

An enumerator that can be used to iterate through the collection.

GetView() GetView() GetView() GetView()

Gets an immutable view of the property set.

public : IMapView<Platform::String, Platform::Object> GetView()
This member is not implemented in C#
This member is not implemented in VB.Net
var iMapView = propertySet.getView();
Returns
IMapView<Platform::String, Platform::Object> IReadOnlyDictionary<string, object> IReadOnlyDictionary<string, object> IReadOnlyDictionary<string, object>

The immutable view.

HasKey(String) HasKey(String) HasKey(String) HasKey(String)

Indicates whether the property set has an item with the specified key.

public : Platform::Boolean HasKey(Platform::String key)
This member is not implemented in C#
This member is not implemented in VB.Net
var bool = propertySet.hasKey(key);
Parameters
key
Platform::String String String String

The key.

Returns
Platform::Boolean bool bool bool

True if the property set has an item with the specified key; otherwise, false.

Insert(String, Object) Insert(String, Object) Insert(String, Object) Insert(String, Object)

Adds an item to the property set.

public : Platform::Boolean Insert(Platform::String key, Platform::Object value)
This member is not implemented in C#
This member is not implemented in VB.Net
var bool = propertySet.insert(key, value);
Parameters
key
Platform::String String String String

The key to insert.

value
Platform::Object Object Object Object

The value to insert.

Returns
Platform::Boolean bool bool bool

True if the method replaces a value that already exists for the key; false if this is a new key.

Lookup(String) Lookup(String) Lookup(String) Lookup(String)

Retrieves the value for the specified key.

public : Platform::Object Lookup(Platform::String key)
This member is not implemented in C#
This member is not implemented in VB.Net
var object = propertySet.lookup(key);
Parameters
key
Platform::String String String String

The key.

Returns
Platform::Object object object object

The value, if an item with the specified key exists. Use the HasKey method to determine whether the key exists.

Remove(TKey) Remove(TKey) Remove(TKey) Remove(TKey)

Removes the element with the specified key from the System.Collections.Generic.IDictionary`2.

This member is not implemented in C++
bool Remove(TKey key)
Function Remove(key As TKey) As Boolean
bool Remove(TKey key)
Parameters
key
TKey TKey TKey TKey

The key of the element to remove.

Returns

true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original System.Collections.Generic.IDictionary`2.

Exceptions

key is null.

The System.Collections.Generic.IDictionary`2 is read-only.

Remove(String) Remove(String) Remove(String) Remove(String)

Removes an item from the property set.

public : void Remove(Platform::String key)
This member is not implemented in C#
This member is not implemented in VB.Net
propertySet.remove(key);
Parameters
key
Platform::String String String String

The key.

Remarks

For the C# or Microsoft Visual Basic version of the Remove method, see Remove.

TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue)

Gets the value associated with the specified key.

This member is not implemented in C++
bool TryGetValue(TKey key, out TValue value)
Function TryGetValue(key As TKey, ByRef value As TValue) As Boolean
bool TryGetValue(TKey key, out TValue value)
Parameters
key
TKey TKey TKey TKey

The key whose value to get.

value
TValue TValue TValue TValue

When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

true if the object that implements System.Collections.Generic.IDictionary`2 contains an element with the specified key; otherwise, false.

Exceptions

key is null.

Events

MapChanged MapChanged MapChanged MapChanged

Occurs when the observable map has changed.

public : event MapChangedEventHandler MapChanged<Platform::String, object>
public event MapChangedEventHandler MapChanged<string, object>
Public Event MapChangedEventHandler MapChanged( Of ( Of string ), ( Of object ))
function onMapChanged(eventArgs){/* Your code */}


propertySet.addEventListener("mapChanged", onMapChanged);
propertySet.removeEventListener("mapChanged", onMapChanged);