Edit

Share via


ThicknessAnimation Class

Definition

Animates the value of a Thickness property between two target values using linear interpolation over a specified Duration.

public ref class ThicknessAnimation : System::Windows::Media::Animation::ThicknessAnimationBase
public class ThicknessAnimation : System.Windows.Media.Animation.ThicknessAnimationBase
type ThicknessAnimation = class
    inherit ThicknessAnimationBase
Public Class ThicknessAnimation
Inherits ThicknessAnimationBase
Inheritance

Remarks

An animation updates the value of a property over a period of time. An animation effect can be subtle, such as moving a Shape a few pixels left and right, or dramatic, such as enlarging an object to 200 times its original size while spinning it and changing its color. To create an animation in Windows Presentation Foundation (WPF), you associate an animation with an object's property value.

Target Values

The ThicknessAnimation class creates a transition between two target values. To set its target values, use its From, To, and By properties. The following table summarizes how the From, To, and By properties may be used together or separately to determine an animation's target values.

Properties specified Resulting behavior
From The animation progresses from the value specified by the From property to the base value of the property being animated or to a previous animation's output value, depending on how the previous animation is configured.
From and To The animation progresses from the value specified by the From property to the value specified by the To property.
From and By The animation progresses from the value specified by the From property to the value specified by the sum of the From and By properties.
To The animation progresses from the animated property's base value or a previous animation's output value to the value specified by the To property.
By The animation progresses from the base value of the property being animated or a previous animation's output value to the sum of that value and the value specified by the By property.

Note

If you set both the To and By properties, the To property takes precedence and the By property is ignored.

To use other interpolation methods or animate between more than two target values, use a ThicknessAnimationUsingKeyFrames object.

For information about applying multiple animations to a single property, see Key-Frame Animations Overview.

Freezable Features

Because the ThicknessAnimation class inherits from Freezable, ThicknessAnimation objects gain several special features, which include the following: they can be declared as resources, shared among multiple objects, made read-only to improve performance, cloned, and made thread-safe. For more information about the different features provided by Freezable objects, see the Freezable Objects Overview.

Constructors

ThicknessAnimation()

Initializes a new instance of the ThicknessAnimation class.

ThicknessAnimation(Thickness, Duration)

Initializes a new instance of the ThicknessAnimation class that animates to the specified value over the specified duration. The starting value for the animation is the base value of the property being animated or the output from another animation.

ThicknessAnimation(Thickness, Duration, FillBehavior)

Initializes a new instance of the ThicknessAnimation class that animates to the specified value over the specified duration and has the specified fill behavior. The starting value for the animation is the base value of the property being animated or the output from another animation.

ThicknessAnimation(Thickness, Thickness, Duration)

Initializes a new instance of the ThicknessAnimation class that animates from the specified starting value to the specified destination value over the specified duration.

ThicknessAnimation(Thickness, Thickness, Duration, FillBehavior)

Initializes a new instance of the ThicknessAnimation class that animates from the specified starting value to the specified destination value over the specified duration and has the specified fill behavior.

Fields

ByProperty

Identifies the By dependency property.

EasingFunctionProperty

Identifies the EasingFunction dependency property.

FromProperty

Identifies the From dependency property.

ToProperty

Identifies the To dependency property.

Properties

AccelerationRatio

Gets or sets a value specifying the percentage of the timeline's Duration spent accelerating the passage of time from zero to its maximum rate.

(Inherited from Timeline)
AutoReverse

Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration.

(Inherited from Timeline)
BeginTime

Gets or sets the time at which this Timeline should begin.

(Inherited from Timeline)
By

Gets or sets the total amount by which the animation changes its starting value.

CanFreeze

Gets a value that indicates whether the object can be made unmodifiable.

(Inherited from Freezable)
DecelerationRatio

Gets or sets a value specifying the percentage of the timeline's Duration spent decelerating the passage of time from its maximum rate to zero.

(Inherited from Timeline)
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)
Duration

Gets or sets the length of time for which this timeline plays, not counting repetitions.

(Inherited from Timeline)
EasingFunction

Gets or sets the easing function applied to this animation.

FillBehavior

Gets or sets a value that specifies how the Timeline behaves after it reaches the end of its active period.

(Inherited from Timeline)
From

Gets or sets the animation's starting value.

HasAnimatedProperties

Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.

(Inherited from Animatable)
IsAdditive

Gets or sets a value that indicates whether the target property's current value should be added to this animation's starting value.

IsCumulative

Gets or sets a value that specifies whether the animation's value accumulates when it repeats.

IsDestinationDefault

Gets a value that indicates whether this animation uses the defaultDestinationValue parameter of the GetCurrentValue(Object, Object, AnimationClock) method as its destination value.

(Inherited from AnimationTimeline)
IsFrozen

Gets a value that indicates whether the object is currently modifiable.

(Inherited from Freezable)
IsSealed

Gets a value that indicates whether this instance is currently sealed (read-only).

(Inherited from DependencyObject)
Name

Gets or sets the name of this Timeline.

(Inherited from Timeline)
RepeatBehavior

Gets or sets the repeating behavior of this timeline.

(Inherited from Timeline)
SpeedRatio

Gets or sets the rate, relative to its parent, at which time progresses for this Timeline.

(Inherited from Timeline)
TargetPropertyType

Gets the type of value this animation generates.

(Inherited from ThicknessAnimationBase)
To

Gets or sets the animation's ending value.

Methods

AllocateClock()

Creates a Clock for this AnimationTimeline.

(Inherited from AnimationTimeline)
ApplyAnimationClock(DependencyProperty, AnimationClock)

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.

(Inherited from Animatable)
ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.

(Inherited from Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline)

Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used.

(Inherited from Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)

Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used.

(Inherited from Animatable)
CheckAccess()

Determines whether the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)
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 ThicknessAnimation, 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 the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values.

(Inherited from Freezable)
CloneCurrentValue()

Creates a modifiable clone of this Timeline object, making deep copies of this object's current values.

(Inherited from Timeline)
CloneCurrentValueCore(Freezable)

Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values.

(Inherited from Freezable)
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)
CreateClock()

Creates a new AnimationClock from this AnimationTimeline.

(Inherited from AnimationTimeline)
CreateClock(Boolean)

Creates a new Clock from this Timeline and specifies whether the new Clock is controllable. If this Timeline has children, a tree of clocks is created with this Timeline as the root.

(Inherited from Timeline)
CreateInstance()

Initializes a new instance of the Freezable class.

(Inherited from Freezable)
CreateInstanceCore()

Creates a new instance of the ThicknessAnimation.

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 Timeline unmodifiable or determines whether it can be made unmodifiable.

(Inherited from Timeline)
GetAnimationBaseValue(DependencyProperty)

Returns the non-animated value of the specified DependencyProperty.

(Inherited from Animatable)
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 Timeline object.

(Inherited from Timeline)
GetCurrentValue(Object, Object, AnimationClock)

Gets the current value of the animation.

(Inherited from ThicknessAnimationBase)
GetCurrentValue(Thickness, Thickness, AnimationClock)

Gets the current value of the animation.

(Inherited from ThicknessAnimationBase)
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 Timeline. Resource references, data bindings, and animations are not copied, but their current values are.

(Inherited from Timeline)
GetCurrentValueCore(Thickness, Thickness, AnimationClock)

Calculates a value that represents the current value of the property being animated, as determined by the ThicknessAnimation.

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

Returns the length of a single iteration of this Timeline.

(Inherited from Timeline)
GetNaturalDurationCore(Clock)

Returns the length of a single iteration of this AnimationTimeline.

(Inherited from AnimationTimeline)
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)
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)
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)
Completed

Occurs when this timeline has completely finished playing: it will no longer enter its active period.

(Inherited from Timeline)
CurrentGlobalSpeedInvalidated

Occurs when the rate at which time progresses for the timeline's clock changes.

(Inherited from Timeline)
CurrentStateInvalidated

Occurs when the CurrentState property of the timeline's Clock is updated.

(Inherited from Timeline)
CurrentTimeInvalidated

Occurs when the CurrentTime property of the timeline's Clock is updated.

(Inherited from Timeline)
RemoveRequested

Occurs when the clock created for this timeline or one of its parent timelines is removed.

(Inherited from Timeline)

Applies to

See also