Bitmap​Property​Set Bitmap​Property​Set Bitmap​Property​Set Bitmap​Property​Set Class

Definition

Represents a property set of BitmapTypedValue objects.

public : sealed class BitmapPropertySet : IIterable, IMappublic sealed class BitmapPropertySet : IEnumerable, IDictionaryPublic NotInheritable Class BitmapPropertySet Implements IEnumerable, IDictionary// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

BitmapPropertySet is a map with keys of type String and values of type BitmapTypedValue. Each String key is either a Windows property key or native metadata query.

Collection member lists

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

Constructors

BitmapPropertySet() BitmapPropertySet() BitmapPropertySet() BitmapPropertySet()

Creates and initializes a new instance of the bitmap property set.

public : BitmapPropertySet()public BitmapPropertySet()Public Sub New()// You can use this method in JavaScript.

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 TValueTValue 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 short Size { get; }This member is not implemented in C#This member is not implemented in VB.Net// You can use this property in JavaScript.
Value
unsigned short 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// You can use this method in JavaScript.

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 Booleanbool 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, BitmapTypedValue>> First()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Returns
IIterator<IKeyValuePair<PlatForm::String, BitmapTypedValue>> IIterator<KeyValuePair<string, BitmapTypedValue>> IIterator<KeyValuePair<string, BitmapTypedValue>> IIterator<KeyValuePair<string, BitmapTypedValue>>

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, BitmapTypedValue> GetView()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Returns
IMapView<PlatForm::String, BitmapTypedValue> IReadOnlyDictionary<string, BitmapTypedValue> IReadOnlyDictionary<string, BitmapTypedValue> IReadOnlyDictionary<string, BitmapTypedValue>

The immutable view.

See Also

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// You can use this method in JavaScript.
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, BitmapTypedValue) Insert(String, BitmapTypedValue) Insert(String, BitmapTypedValue) Insert(String, BitmapTypedValue)

Adds an item to the property set.

public : PlatForm::Boolean Insert(PlatForm::String key, BitmapTypedValue value)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
key
PlatForm::String String String String

The key 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.

See Also

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

Retrieves the value for the specified key.

public : BitmapTypedValue Lookup(PlatForm::String key)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
key
PlatForm::String String String String

The key.

Returns

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

See Also

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 Booleanbool 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// You can use this method in JavaScript.
Parameters
key
PlatForm::String String String String

The key.

Remarks

For the C# or Microsoft Visual Basic version of the Remove(String) 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 Booleanbool 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.

See Also