Double​Key​Frame​Collection Double​Key​Frame​Collection Double​Key​Frame​Collection Class

Definition

Represents a collection of DoubleKeyFrame objects that can be individually accessed by index. DoubleKeyFrameCollection is the value of the DoubleAnimationUsingKeyFrames.KeyFrames property.

public sealed class DoubleKeyFrameCollection : IIterable, IVectorpublic sealed class DoubleKeyFrameCollection : IEnumerable, IListPublic NotInheritable Class DoubleKeyFrameCollection Implements IEnumerable, IList
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Enumerating the collection in C# or Microsoft Visual Basic

A DoubleKeyFrameCollection is enumerable, so you can use language-specific syntax such as foreach in C# to enumerate the items in the collection. The compiler does the type-casting for you and you won't need to cast to IEnumerable<DoubleKeyFrame> explicitly. If you do need to cast explicitly, for example if you want to call GetEnumerator, cast to IEnumerable<T> with a DoubleKeyFrame constraint.

Constructors

DoubleKeyFrameCollection() DoubleKeyFrameCollection() DoubleKeyFrameCollection()

Initializes a new instance of the DoubleKeyFrameCollection class.

public DoubleKeyFrameCollection()public DoubleKeyFrameCollection()Public Sub New()
Attributes

Properties

Item[Int32] Item[Int32] Item[Int32]

Gets or sets the element at the specified index.

This member is not implemented in C++T this[int index] { get; set; }Property Item(index As Integer) As T
Parameters
index
System.Int32 System.Int32 System.Int32

The zero-based index of the element to get or set.

Value
T T T

The element at the specified index.

Attributes
See Also
System.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnly

Size Size Size

Gets the size (count) of the collection.

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

The count of items in the collection.

Attributes

Methods

Append(DoubleKeyFrame) Append(DoubleKeyFrame) Append(DoubleKeyFrame)

Adds a new item to the collection.

public void Append(DoubleKeyFrame value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
value
DoubleKeyFrame DoubleKeyFrame DoubleKeyFrame

The new item to add.

Attributes

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
Attributes

First() First() First()

Returns the iterator for iteration over the items in the collection.

public IIterator<DoubleKeyFrame> First()This member is not implemented in C#This member is not implemented in VB.Net
Returns

The iterator object. The iterator's current position is at the 0-index position, or at the collection end if the collection is empty.

Attributes

GetAt(UInt32) GetAt(UInt32) GetAt(UInt32)

Returns the DoubleKeyFrame located at the specified index.

public DoubleKeyFrame GetAt(UInt32 index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

The integer index for the value to retrieve.

Returns

The DoubleKeyFrame value at the specified index.

Attributes

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)
Returns
System.Collections.Generic.IEnumerator<T> System.Collections.Generic.IEnumerator<T> System.Collections.Generic.IEnumerator<T>

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

Attributes
See Also
System.Collections.Generic.IEnumerator<T>System.Collections.Generic.IEnumerator<T>System.Collections.Generic.IEnumerator<T>

GetMany(UInt32, DoubleKeyFrame[]) GetMany(UInt32, DoubleKeyFrame[]) GetMany(UInt32, DoubleKeyFrame[])

Retrieves multiple elements in a single pass through the iterator.

public uint GetMany(UInt32 startIndex, DoubleKeyFrame[] items)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
startIndex
System.UInt32 System.UInt32 System.UInt32

The index from which to start retrieval.

items
Windows.UI.Xaml.Media.Animation.DoubleKeyFrame[] Windows.UI.Xaml.Media.Animation.DoubleKeyFrame[] Windows.UI.Xaml.Media.Animation.DoubleKeyFrame[]

Provides the destination for the result. Size the initial array size as a capacity in order to specify how many results should be retrieved.

Returns
uint uint uint

The number of items retrieved.

Attributes

Remarks

The GetMany method operates identically as if calling and for each element in the supplied array. This means that the first element returned by the GetMany method is the same element as returned by retrieving the property prior to calling GetMany. After the GetMany call returns, the property will retrieve the element following the last element returned by the GetMany call, or produce an error if no more elements exist in the sequences.

The GetMany method returns the actual number of elements returned. It must be the minimum of a) the number of elements remaining in the collection, or b) the number of elements requested, that is, capacity. Therefore, whenever GetMany returns less than the number of elements requested, the end of the sequence has been reached. It returns the number of elements retrieved in the actual output parameter. When the caller specifies a capacity of zero, the position of the iterator is unchanged. Elements in the array following the values returned are unchanged.

GetView() GetView() GetView()

Gets an immutable view into the collection.

public IVectorView<DoubleKeyFrame> GetView()This member is not implemented in C#This member is not implemented in VB.Net
Returns

An object representing the immutable collection view.

Attributes

IndexOf(T) IndexOf(T) IndexOf(T)

Determines the index of a specific item in the System.Collections.Generic.IList`1.

This member is not implemented in C++int IndexOf(T item)Function IndexOf(item As T) As Integer
Parameters
item
T T T

The object to locate in the System.Collections.Generic.IList`1.

Returns
System.Int32 System.Int32 System.Int32

The index of item if found in the list; otherwise, -1.

Attributes

IndexOf(DoubleKeyFrame, UInt32) IndexOf(DoubleKeyFrame, UInt32) IndexOf(DoubleKeyFrame, UInt32)

Retrieves the index of the specified item.

public bool IndexOf(DoubleKeyFrame value, UInt32 index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
value
DoubleKeyFrame DoubleKeyFrame DoubleKeyFrame

The value to find in the collection.

index
System.UInt32 System.UInt32 System.UInt32

The index of the item to find, if found.

Returns
bool bool bool

true if an item with the specified value was found; otherwise, false.

Attributes

Insert(Int32, T) Insert(Int32, T) Insert(Int32, T)

Inserts an item to the System.Collections.Generic.IList`1 at the specified index.

This member is not implemented in C++void Insert(int index, T item)Sub Insert(index As Integer, item As T)
Parameters
index
System.Int32 System.Int32 System.Int32

The zero-based index at which item should be inserted.

item
T T T

The object to insert into the System.Collections.Generic.IList`1.

Attributes
See Also
System.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnly

InsertAt(UInt32, DoubleKeyFrame) InsertAt(UInt32, DoubleKeyFrame) InsertAt(UInt32, DoubleKeyFrame)

Inserts the specified item at the specified index.

public void InsertAt(UInt32 index, DoubleKeyFrame value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

The index at which to set the value.

value
DoubleKeyFrame DoubleKeyFrame DoubleKeyFrame

The value to set.

Attributes

Remarks

InsertAt expands the collection and moves all subsequent index items by one.

In contrast, SetAt replaces the item at the index, and the collection count remains the same.

RemoveAt(Int32) RemoveAt(Int32) RemoveAt(Int32)

Removes the System.Collections.Generic.IList`1 item at the specified index.

This member is not implemented in C++void RemoveAt(int index)Sub RemoveAt(index As Integer)
Parameters
index
System.Int32 System.Int32 System.Int32

The zero-based index of the item to remove.

Attributes
See Also
System.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnly

RemoveAt(UInt32) RemoveAt(UInt32) RemoveAt(UInt32)

Removes the item at the specified index.

public void RemoveAt(UInt32 index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

The index position of the item to remove.

Attributes

Remarks

If successful, calling this method reduces the collection size by one. Items with index values greater than the called index have their index values reduced by one.

RemoveAtEnd() RemoveAtEnd() RemoveAtEnd()

Removes the last item in the collection.

public void RemoveAtEnd()This member is not implemented in C#This member is not implemented in VB.Net
Attributes

Remarks

If successful, calling this method reduces the collection size by one.

ReplaceAll(DoubleKeyFrame[]) ReplaceAll(DoubleKeyFrame[]) ReplaceAll(DoubleKeyFrame[])

Initially clears the collection, then inserts the provided array as new items.

public void ReplaceAll(DoubleKeyFrame[] items)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
items
Windows.UI.Xaml.Media.Animation.DoubleKeyFrame[] Windows.UI.Xaml.Media.Animation.DoubleKeyFrame[] Windows.UI.Xaml.Media.Animation.DoubleKeyFrame[]

The new collection items.

Attributes

Remarks

For implementations that track a changed event, the initial reset raises an event, but the items added do not fire discrete events.

SetAt(UInt32, DoubleKeyFrame) SetAt(UInt32, DoubleKeyFrame) SetAt(UInt32, DoubleKeyFrame)

Sets the value at the specified index to the DoubleKeyFrame value specified.

public void SetAt(UInt32 index, DoubleKeyFrame value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

The index at which to set the value.

value
DoubleKeyFrame DoubleKeyFrame DoubleKeyFrame

The value to set.

Attributes

Remarks

InsertAt expands the collection and moves all subsequent index items by one.

In contrast, SetAt replaces the item at the index, and the collection count remains the same.

See Also