BooleanKeyFrameCollection Class

Definition

Namespace:

System.Windows.Media.Animation

Assembly:

PresentationCore.dll

Represents a collection of BooleanKeyFrame objects.

public ref class BooleanKeyFrameCollection : System::Windows::Freezable, System::Collections::IList

public class BooleanKeyFrameCollection : System.Windows.Freezable, System.Collections.IList

type BooleanKeyFrameCollection = class
    inherit Freezable
    interface ICollection
    interface IEnumerable
    interface IList

Public Class BooleanKeyFrameCollection
Inherits Freezable
Implements IList

Inheritance

Object

DispatcherObject

DependencyObject

Freezable

BooleanKeyFrameCollection

Implements

ICollection IEnumerable IList

Examples

The following example demonstrates how to use a BooleanAnimationUsingKeyFrames animation.

<!-- Demonstrates a BooleanAnimationUsingKeyFrames. The animation is used to
     animate the IsEnabled property of a button. -->
<Page xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  x:Class="Microsoft.Samples.KeyFrameAnimations.BooleanAnimationUsingKeyFramesExample"
  Name="myRootElement"
  WindowTitle="KeyFrameBoolean Animation Example">


  <StackPanel Orientation="Vertical" Margin="20">
  
    <TextBlock>
        Click the button to animate the its IsEnabled property with a 
        BooleanAnimationUsingKeyFrames animation.
    </TextBlock>
  
    <Button Name="myAnimatedButton" Margin="200">Click Me
      <Button.Triggers>
        <EventTrigger RoutedEvent="Button.Click">
          <BeginStoryboard>
            <Storyboard>
              <BooleanAnimationUsingKeyFrames 
                Storyboard.TargetName="myAnimatedButton" Storyboard.TargetProperty="(Button.IsEnabled)"
                Duration="0:0:4" FillBehavior="HoldEnd">

                <!-- All the key frames below are DiscreteBooleanKeyFrames. Discrete key frames create 
                sudden "jumps" between values (no interpolation). Only discrete key frames can be used 
                for Boolean key frame animations. -->
                <DiscreteBooleanKeyFrame Value="False" KeyTime="0:0:0" />
                <DiscreteBooleanKeyFrame Value="True" KeyTime="0:0:1" />
                <DiscreteBooleanKeyFrame Value="False" KeyTime="0:0:2" />
                <DiscreteBooleanKeyFrame Value="True" KeyTime="0:0:3" />
                <DiscreteBooleanKeyFrame Value="False" KeyTime="0:0:3.5" />
                <DiscreteBooleanKeyFrame Value="True" KeyTime="0:0:4" />
              </BooleanAnimationUsingKeyFrames>            
            </Storyboard>
          </BeginStoryboard>
        </EventTrigger>
      </Button.Triggers>
    </Button>
  </StackPanel>
</Page>

Remarks

This collection is used as part of a BooleanAnimationUsingKeyFrames to animate a Boolean property value along a set of key frames.

XAML Implicit Collection Usage

<object>  
  <object.property>  
    oneOrMoreBooleanKeyFrames  
  </object.property>  
</object>  

XAML Values

oneOrMoreBooleanKeyFrames
One or more BooleanKeyFrame objects, declared using object element syntax.

Constructors

BooleanKeyFrameCollection()

Initializes a new instance of the BooleanKeyFrameCollection class.

Properties

CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable)
Count	Gets the number of key frames contained in the BooleanKeyFrameCollection.
DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject)
Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject)
Empty	Gets an empty BooleanKeyFrameCollection.
IsFixedSize	Gets a value that indicates if the collection size can ever change.
IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable)
IsReadOnly	Gets a value that indicates if the collection is read-only.
IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject)
IsSynchronized	Gets a value that indicates whether access to the collection is synchronized (thread-safe).
Item[Int32]	Gets or sets the BooleanKeyFrame at the specified index position.
SyncRoot	Gets an object that can be used to synchronize access to the collection.

Methods

Add(BooleanKeyFrame)	Adds a BooleanKeyFrame to the end of the collection.
CheckAccess()	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)
Clear()	Removes all BooleanKeyFrame objects from the collection.
ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject)
ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject)
Clone()	Creates a modifiable clone of this BooleanKeyFrameCollection, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.
CloneCore(Freezable)	Makes this instance a deep copy of the specified BooleanKeyFrameCollection. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.
CloneCurrentValue()	Creates a modifiable clone (deep copy) of the Freezable using its current values. (Inherited from Freezable)
CloneCurrentValueCore(Freezable)	Makes this instance a modifiable deep copy of the specified BooleanKeyFrameCollection using current property values. Resource references, data bindings, and animations are not copied, but their current values are.
CoerceValue(DependencyProperty)	Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject)
Contains(BooleanKeyFrame)	Indicates whether the collection contains the specified BooleanKeyFrame.
CopyTo(BooleanKeyFrame[], Int32)	Copies all of the BooleanKeyFrame objects in a collection to a specified array.
CreateInstance()	Initializes a new instance of the Freezable class. (Inherited from Freezable)
CreateInstanceCore()	Creates a new, frozen instance of BooleanKeyFrameCollection.
Equals(Object)	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject)
Freeze()	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable)
FreezeCore(Boolean)	Makes this instance of BooleanKeyFrameCollection read-only or determines whether it can be made read-only.
GetAsFrozen()	Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable)
GetAsFrozenCore(Freezable)	Makes this instance a clone of the specified BooleanKeyFrameCollection object.
GetCurrentValueAsFrozen()	Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable)
GetCurrentValueAsFrozenCore(Freezable)	Makes this instance a frozen clone of the specified BooleanKeyFrameCollection. Resource references, data bindings, and animations are not copied, but their current values are.
GetEnumerator()	Returns an enumerator that can iterate through the collection.
GetHashCode()	Gets a hash code for this DependencyObject. (Inherited from DependencyObject)
GetLocalValueEnumerator()	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject)
IndexOf(BooleanKeyFrame)	Searches for the specified BooleanKeyFrame and returns the zero-based index of the first occurrence within the entire collection.
Insert(Int32, BooleanKeyFrame)	Inserts a BooleanKeyFrame into a specific location within the collection.
InvalidateProperty(DependencyProperty)	Re-evaluates the effective value for the specified dependency property. (Inherited from DependencyObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnChanged()	Called when the current Freezable object is modified. (Inherited from Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject)	Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)	This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable)
OnPropertyChanged(DependencyPropertyChangedEventArgs)	Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject)
ReadPreamble()	Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable)
Remove(BooleanKeyFrame)	Removes a BooleanKeyFrame object from the collection.
RemoveAt(Int32)	Removes the BooleanKeyFrame at the specified index position from the collection.
SetCurrentValue(DependencyProperty, Object)	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject)
SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject)
ShouldSerializeProperty(DependencyProperty)	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject)
ToString()	Returns a string that represents the current object. (Inherited from Object)
VerifyAccess()	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)
WritePostscript()	Raises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable)
WritePreamble()	Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable)

Events

Changed

Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)	Copies the elements of the ICollection to an Array, starting at a particular Array index.
IList.Add(Object)	Adds an item to the IList.
IList.Contains(Object)	Determines whether the IList contains a specific value.
IList.IndexOf(Object)	Determines the index of a specific item in the IList.
IList.Insert(Int32, Object)	Inserts an item to the IList at the specified index.
IList.Item[Int32]	Gets or sets the element at the specified index.
IList.Remove(Object)	Removes the first occurrence of a specific object from the IList.

Extension Methods

See also

• BooleanKeyFrame
• KeyFrame Animation Sample