DependencyObject.GetAnimationBaseValue Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active.

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

Syntax

'Declaration
Public Function GetAnimationBaseValue ( _
    dp As DependencyProperty _
) As Object
public Object GetAnimationBaseValue(
    DependencyProperty dp
)

Parameters

Return Value

Type: System.Object
The returned base value.

Exceptions

Exception Condition
ArgumentNullException

dp is nulla null reference (Nothing in Visual Basic).

Remarks

An animated value acts at highest precedence in the dependency property system, and will return values that can mask other value determinants while the animation is running. You can call GetAnimationBaseValue in order to return the underlying value that might apply as soon as the animation is stopped. Note however that it is possible to specify an animation with a HoldEnd behavior, which means that even a stopped animation will continue to hold the animation-based value after the animation's timeline is visually or apparently stopped.

For more information on animation concepts, see Animation Overview.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.