StringMap StringMap StringMap StringMap Class

Definition

Namespace:: Windows.Foundation.Collections Windows.Foundation.Collections Windows.Foundation.Collections Windows.Foundation.Collections

Edit

An associative collection, also known as a map or a dictionary.

public : sealed class StringMap : IIterable, IMap, IObservableMappublic sealed class StringMap : IEnumerable, IDictionary, IObservableMapPublic NotInheritable Class StringMap Implements IEnumerable, IDictionary, IObservableMap// You can use this class in JavaScript.

Attributes: ActivatableAttribute ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows 10 requirements

Device family	Windows 10 (introduced v10.0.10240.0)
API contract	Windows.Foundation.FoundationContract (introduced v1)

Remarks

This class allows JavaScript to easily iterate over a collection for which strings are the only expected value for both keys and values.

Constructors

StringMap() StringMap() StringMap() StringMap()

Edit

Creates and initializes a new instance of the StringMap.

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

Properties

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

Edit

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

Edit

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

Edit

Gets the number of items in the map.

public : unsigned int 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 int uint uint uint

The number of items in the map.

Values Values Values Values

Edit

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)

Edit

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()

Edit

Removes all items from the map.

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)

Edit

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()

Edit

Returns an iterator containing the items in the collection.

public : IIterator<IKeyValuePair<PlatForm::String, PlatForm::String>> 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, PlatForm::String>> IIterator<KeyValuePair<string, string>> IIterator<KeyValuePair<string, string>> IIterator<KeyValuePair<string, string>>

The items in the collection.

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

Edit

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()

Edit

Returns an immutable view of the map.

public : IMapView<PlatForm::String, PlatForm::String> 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, PlatForm::String> IReadOnlyDictionary<string, string> IReadOnlyDictionary<string, string> IReadOnlyDictionary<string, string>

The view of the map.

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

Edit

Determines whether the map contains 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 associated with the item to locate.

Returns

PlatForm::Boolean bool bool bool

True if the key is found; otherwise, false.

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

Edit

Inserts or replaces an item in the map.

public : PlatForm::Boolean Insert(PlatForm::String key, PlatForm::String 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 associated with the item to insert.

value: PlatForm::String String String String

The item to insert.

Returns

PlatForm::Boolean bool bool bool

True if an item with the specified key is an existing item that was replaced; otherwise, false.

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

Edit

Returns the item at the specified key in the map.

public : PlatForm::String 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 associated with the item to locate.

Returns

PlatForm::String string string string

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)

Edit

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)

Edit

Removes an item from the map.

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 associated with the item to remove.

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

Edit

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.

Events

MapChanged MapChanged MapChanged MapChanged

Edit

Occurs when the contents of the map change.

public : event MapChangedEventHandler MapChanged<string,  string>public event MapChangedEventHandler MapChanged<string,  string>Public Event MapChanged<string,  string>// You can use this event in JavaScript.