DependencyObject.GetValue(DependencyProperty) Method

Definition

Returns the current effective value of a dependency property on this instance of a DependencyObject.

public:
 System::Object ^ GetValue(System::Windows::DependencyProperty ^ dp);
public object GetValue (System.Windows.DependencyProperty dp);
member this.GetValue : System.Windows.DependencyProperty -> obj
Public Function GetValue (dp As DependencyProperty) As Object

Parameters

dp
DependencyProperty

The DependencyProperty identifier of the property to retrieve the value for.

Returns

Returns the current effective value.

Exceptions

The specified dp or its value was invalid, or the specified dp does not exist.

Remarks

The effective value is the value of the property that is returned by the property system to any caller that is requesting the value. The effective value is the result of the property system having evaluated all the possible inputs that participate in the property system value precedence. This includes coercion and animation. For more information, see Dependency Property Value Precedence.

This method will never return UnsetValue. The UnsetValue is a sentinel value for the property system that is used in various capacities internally and occasionally also exposed through coercion callbacks.

If you are not sure what the property's type should be, you can query the identifier of the requested dependency property to determine whether there is a more specific PropertyType that the return value can be converted to.

Applies to

See also