DependencyObject.ReadLocalValue(DependencyProperty) Method

Definition

Returns the local value of a dependency property, if it exists.

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

Parameters

dp
DependencyProperty

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

Returns

Returns the local value, or returns the sentinel value UnsetValue if no local value is set.

Remarks

You should use GetValue for most typical "get" operations for a dependency property. ReadLocalValue does not return the effective value for a variety of circumstances where the value was not locally set.

Values that are set by styles, themes, templates, the default value from metadata, or property value inheritance are not considered to be local values. However, bindings and other expressions are considered to be local values, after they have been evaluated.

When no local value is set, this method returns UnsetValue.

If the returned value is other than UnsetValue, you can query the metadata of the requested dependency property to determine whether there is a more specific type that the return value can be converted to.

Applies to

See also