UIElement.GetAnimationBaseValue Method (DependencyProperty)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns the base property value for the specified property on this element, disregarding any possible animated value from a running or stopped animation.

Namespace:   System.Windows
Assembly:  PresentationCore (in PresentationCore.dll)

public object GetAnimationBaseValue(
	DependencyProperty dp
)

Parameters

dp
Type: System.Windows.DependencyProperty

The dependency property to check.

Return Value

Type: System.Object

The property value as if no animations are attached to the specified dependency property.

If no animations are attached to the property, then the GetAnimationBaseValue return value is always identical to the GetValue return value. If there are animations attached, then all possible animation derived values including the start and stop values are ignored, and the property value is determined based on all other possible inputs. For more information, see Dependency Property Value Precedence.

The following example implements a handler that reports the base value of an animated Width property on a Button, as well as the base value of a transform.

// Display the base value for Button.Width and RotateTransform.Angle.
private void animatedButton_Clicked(object sender, RoutedEventArgs e)
{
    Button animatedButton = (Button)sender;
    MessageBox.Show("Button width base value: " + 
        animatedButton.GetAnimationBaseValue(Button.WidthProperty)
        + "\nRotateTransform base value: " +
        animatedRotateTransform.GetAnimationBaseValue(RotateTransform.AngleProperty));

}

.NET Framework
Available since 3.0
Return to top
Show: