UIElement.GetAnimationBaseValue(DependencyProperty) Method

Reference

Definition

Namespace:: System.Windows

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 virtual System::Object ^ GetAnimationBaseValue(System::Windows::DependencyProperty ^ dp);

public object GetAnimationBaseValue (System.Windows.DependencyProperty dp);

abstract member GetAnimationBaseValue : System.Windows.DependencyProperty -> obj
override this.GetAnimationBaseValue : System.Windows.DependencyProperty -> obj

Public Function GetAnimationBaseValue (dp As DependencyProperty) As Object

Parameters

dp: DependencyProperty

The dependency property to check.

Returns

Object

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

Implements

GetAnimationBaseValue(DependencyProperty)

Examples

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));
}

' Display the base value for Button.Width and RotateTransform.Angle.
Private Sub animatedButton_Clicked(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Dim animatedButton As Button = CType(sender, Button)
    MessageBox.Show("Button width base value: " & animatedButton.GetAnimationBaseValue(Button.WidthProperty).ToString & vbLf & "RotateTransform base value: " & animatedRotateTransform.GetAnimationBaseValue(RotateTransform.AngleProperty).ToString)
End Sub

Remarks

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.

Applies to

Jaa