DependencyObject.OnPropertyChanged(DependencyPropertyChangedEventArgs) Method
Definition
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.
Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data.
protected:
virtual void OnPropertyChanged(System::Windows::DependencyPropertyChangedEventArgs e);protected virtual void OnPropertyChanged (System.Windows.DependencyPropertyChangedEventArgs e);abstract member OnPropertyChanged : System.Windows.DependencyPropertyChangedEventArgs -> unit
override this.OnPropertyChanged : System.Windows.DependencyPropertyChangedEventArgs -> unitProtected Overridable Sub OnPropertyChanged (e As DependencyPropertyChangedEventArgs)Parameters
Event data that will contain the dependency property identifier of interest, the property metadata for the type, and old and new values.
Remarks
This method is not intended to generally detect individual property changes or perform invalidations of properties on a per-case basis. OnPropertyChanged is instead intended for modifications of the general invalidation pattern, if certain information is known about wide classifications of properties. For example, changes in a Freezable might be changes in the value types of the Freezable, or might be subproperties, where the changes are within other Freezable references. The Freezable override implementation of OnPropertyChanged uses internal information to determine whether the properties are subproperties, and provides appropriate base class logic for either case.
OnPropertyChanged is potentially invoked many times during the life of an object. Therefore, you can achieve better performance for the overall property system if you override the metadata of specific properties and then attach CoerceValueCallback or PropertyChangedCallback functions for individual properties. However, you would use this method if a DependencyObject includes a significant number of value-interrelated dependency properties, or if it includes logic such as rendering behavior that must be rerun for several related cases of property invalidations.
Notes to Inheritors
Always call the base implementation. Failure to do this will significantly disable the entire WPF property system, causing incorrect values to be reported.
