DataObject.AddPastingHandler Method (DependencyObject, DataObjectPastingEventHandler)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Adds a Pasting event handler to a specified dependency object.

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

Public Shared Sub AddPastingHandler (
	element As DependencyObject,
	handler As DataObjectPastingEventHandler
)

Parameters

element
Type: System.Windows.DependencyObject

The dependency object (a UIElement or ContentElement) to which to add the event handler.

handler
Type: System.Windows.DataObjectPastingEventHandler

A delegate that references the handler method to add.

Use this event to inspect a data object before the data is pasted, and possibly to decide on an alternate course of action, such as:

  • Cancel the Paste - Cancel the entire paste operation by calling the CancelCommand method.

  • Select an Alternate Format - Change the selected paste format by specifying a new value for the FormatToApply property. The newly selected format must by supported by the data object to be pasted.

    System_CAPS_noteNote

    If the paste format is changed, ensure that the paste target supports the newly specified format.

  • Insert a New Format - If you determine that the paste data object does not support the desired format, update the data object to include a version of the data in the desired format. Custom data converters are often used as part of this process.

Changing the content of a paste data object (DataObject) does not change the data stored on the system Clipboard; any such changes will apply only to the data object associated with the associated paste command.

.NET Framework
Available since 3.0
Return to top
Show: