Edit

DataObject.AddSettingDataHandler Method

  • Reference

Definition

Namespace:
System.Windows
Assembly:
PresentationCore.dll

Adds a SettingData event handler to a specified dependency object.

public:
 static void AddSettingDataHandler(System::Windows::DependencyObject ^ element, System::Windows::DataObjectSettingDataEventHandler ^ handler);
public static void AddSettingDataHandler (System.Windows.DependencyObject element, System.Windows.DataObjectSettingDataEventHandler handler);
static member AddSettingDataHandler : System.Windows.DependencyObject * System.Windows.DataObjectSettingDataEventHandler -> unit
Public Shared Sub AddSettingDataHandler (element As DependencyObject, handler As DataObjectSettingDataEventHandler)

Parameters

element
DependencyObject

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

handler
DataObjectSettingDataEventHandler

A delegate that references the handler method to add.

Remarks

The SettingData event occurs as part of a copy or drag command, once for each of the data formats to add to the associated data object. Typically, this event is connected to a content control, such as TextBox.

A handler for this event can be used to selectively prevent unwanted data formats from being added to the data object, thus eliminating data conversion processing for redundant data formats and improving the overall performance of a copy operation. To skip a particular data format, call the CancelCommand method and specify the format to skip in the Format property. Calling the CancelCommand method for this event does not cancel the associated copy or drag command.

Applies to

See also