InitialValueExpressionCollection InitialValueExpressionCollection InitialValueExpressionCollection Class

Definition

A collection of values that specify where an animation will start.

public : sealed class InitialValueExpressionCollection : CompositionObject, IIterable<IKeyValuePair<Platform::String, Platform::String>>, IMap<Platform::String, Platform::String>
public sealed class InitialValueExpressionCollection : CompositionObject, IEnumerable<KeyValuePair<String, String>>, IDictionary<String, String>
Public NotInheritable Class InitialValueExpressionCollection Inherits CompositionObject Implements IEnumerable<KeyValuePair<String, String>>, IDictionary<String, String>
Inheritance
InitialValueExpressionCollectionInitialValueExpressionCollectionInitialValueExpressionCollection
Attributes
Windows 10 requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Properties

Comment Comment Comment

Inherited from CompositionObject

Compositor Compositor Compositor

Inherited from CompositionObject

Dispatcher Dispatcher Dispatcher

Inherited from CompositionObject

DispatcherQueue DispatcherQueue DispatcherQueue

Inherited from CompositionObject

ImplicitAnimations ImplicitAnimations ImplicitAnimations

Inherited from CompositionObject

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

The key of the element to get or set.

Value
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.

Properties Properties Properties

Inherited from CompositionObject

Size Size Size

Gets the size (count) of the collection.

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

The count of items in the collection.

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

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

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

Removes all items from the collection.

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

Close Close Close

Inherited from CompositionObject

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

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

Retrieves the first item 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
Returns
IIterator<IKeyValuePair<Platform::String, Platform::String>> IIterator<KeyValuePair<string, string>> IIterator<KeyValuePair<string, string>>

The first item in the collection.

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

Gets an immutable view into the collection.

public : IMapView<Platform::String, Platform::String> GetView()
This member is not implemented in C#
This member is not implemented in VB.Net
Returns
IMapView<Platform::String, Platform::String> IReadOnlyDictionary<string, string> IReadOnlyDictionary<string, string>

An object representing the immutable collection view.

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

Returns a value that indicates whether the collection 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
Parameters
key
Platform::String String String

The key to check for.

Returns
Platform::Boolean bool bool

true if the key is in the collection; otherwise, false.

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

Inserts an item into the collection.

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
Parameters
key
Platform::String String String

The key to identify the item to insert.

value
Platform::String String String

The item to insert.

Returns
Platform::Boolean bool bool

true if animation was successfully inserted; otherwise, false.

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

Retrieves the item associated with the specified key.

public : Platform::String Lookup(Platform::String key)
This member is not implemented in C#
This member is not implemented in VB.Net
Parameters
key
Platform::String String String

The key that identifies the item to retrieve.

Returns
Platform::String string string

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

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

Removes the specified item from the collection.

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

The key that identifies the item to remove.

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

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.

StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation)

Inherited from CompositionObject

StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase)

Inherited from CompositionObject

StopAnimation(String) StopAnimation(String) StopAnimation(String)

Inherited from CompositionObject

StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase)

Inherited from CompositionObject

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

The key whose value to get.

value
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.