AddPropertyChange(DependencyObject,DependencyPropertyChangedEventArgs,Nullable<Boolean>,String,String) Method

Adds an PropertyChangeUndoUnitBase for the specified property value change to the undo history.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function AddPropertyChange( _
   ByVal owner As DependencyObject, _
   ByVal propertyChangedArgs As DependencyPropertyChangedEventArgs, _
   Optional ByVal preventMerge As Nullable(Of Boolean), _
   Optional ByVal propertyDisplayName As String, _
   Optional ByVal typeDisplayName As String _
) As UndoUnit

C#

public UndoUnit AddPropertyChange( 
   DependencyObject owner,
   DependencyPropertyChangedEventArgs propertyChangedArgs,
   Nullable<bool> preventMerge,
   string propertyDisplayName,
   string typeDisplayName
)

Parameters

owner

The instance whose property was changed

propertyChangedArgs

The DependencyPropertyChangedEventArgs containing the old and new value.

preventMerge

Used to determine if the property change should be prevented from being merged with the top entry on the undo stack when merging is allowed.

propertyDisplayName

The name of the property as it should be displayed to the end user. If this is not specified the actual name of the property will be used.

typeDisplayName

The name of the object whose property is being changed as it should be displayed to the end user.

Return Value

Returns the UndoUnit that was added or null if one was not added

Remarks

Note: In Silverlight a default description may not be able to be properly provided if the Name of the DependencyProperty cannot be obtained.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2