Clipboard.SetDataObject Метод

Определение

Пространство имен:

System.Windows

Сборка:

PresentationCore.dll

Сохраняет указанный объект данных в системном буфере обмена.

Перегрузки

SetDataObject(Object)	Размещает указанный непостоянный объект данных в системном буфере обмена.
SetDataObject(Object, Boolean)	Размещает указанный объект данных в системном буфере обмена и принимает логический параметр, указывающий, следует ли оставлять этот объект в буфере обмена при выходе из приложения.

SetDataObject(Object)

Размещает указанный непостоянный объект данных в системном буфере обмена.

public:
 static void SetDataObject(System::Object ^ data);

public static void SetDataObject (object data);

static member SetDataObject : obj -> unit

Public Shared Sub SetDataObject (data As Object)

Параметры

data

Object

Объект данных (объект, реализующий интерфейс IDataObject) для размещения в системном буфере обмена.

Исключения

ArgumentNullException

data имеет значение null.

ExternalException

Произошла ошибка при доступе к буферу обмена. Подробности исключения содержат HResult, идентифицирующий конкретную ошибку; см. свойство ErrorCode.

Комментарии

По умолчанию данные, помещенные в системный буфер обмена с SetDataObject , автоматически очищаются из буфера обмена при выходе приложения.

Примечание

Поведение по умолчанию очистки буфера обмена при выходе из приложения может отличаться от других реализаций, которые могут оставлять данные в буфере обмена при выходе приложения, а не очищать их по умолчанию. Используйте перегрузку SetDataObject и укажите copy параметр так, как true если вы не хотите удалять данные из буфера обмена при выходе из приложения.

DataObject предоставляет базовую реализацию IDataObject интерфейса .

См. также раздел

• GetDataObject()

SetDataObject(Object, Boolean)

Размещает указанный объект данных в системном буфере обмена и принимает логический параметр, указывающий, следует ли оставлять этот объект в буфере обмена при выходе из приложения.

public:
 static void SetDataObject(System::Object ^ data, bool copy);

public static void SetDataObject (object data, bool copy);

static member SetDataObject : obj * bool -> unit

Public Shared Sub SetDataObject (data As Object, copy As Boolean)

Параметры

data

Object

Объект данных (объект, реализующий интерфейс IDataObject) для размещения в системном буфере обмена.

copy

Boolean

true, чтобы оставить данные в системном буфере обмена при выходе из приложения; false чтобы очистить данные из системного буфера обмена при выходе из приложения.

Исключения

ArgumentNullException

data имеет значение null.

ExternalException

Произошла ошибка при доступе к буферу обмена. Подробности исключения содержат HResult, идентифицирующий конкретную ошибку; см. свойство ErrorCode.

Примеры

В следующем примере показано использование этого метода.

               // For this example, the data to be placed on the clipboard is a simple
               // string.
               string textData = "I want to put this string on the clipboard.";
               // The example will enable auto-conversion of data for this data object.
               bool autoConvert = true;

               // Create a new data object, specifying the data format, data to encapsulate, and enabling
               // auto-conversion services.
               DataObject data = new DataObject(DataFormats.UnicodeText, (Object)textData, autoConvert);
               
               // If the data to be copied is supposed to be persisted after the application ends, 
               // then set the second parameter of SetDataObject to true.
               if(persistentData)
               {
                   // Place the persisted data on the clipboard.
                   Clipboard.SetDataObject(data, true);
               }
               else
               {
                   // Place the non-persisted data on the clipboard.
                   Clipboard.SetDataObject(data, false);
               }

               // If you keep a copy of the source data object, you can use the IsCurrent method to see if
               // the data object is still on the clipboard.
               bool isOriginalDataObject = Clipboard.IsCurrent(data);

' For this example, the data to be placed on the clipboard is a simple
' string.
Dim textData As String = "I want to put this string on the clipboard."
' The example will enable auto-conversion of data for this data object.
Dim autoConvert As Boolean = True

' Create a new data object, specifying the data format, data to encapsulate, and enabling
' auto-conversion services.
Dim data As New DataObject(DataFormats.UnicodeText, CType(textData, Object), autoConvert)

' If the data to be copied is supposed to be persisted after the application ends, 
' then set the second parameter of SetDataObject to true.
If persistentData Then
    ' Place the persisted data on the clipboard.
    Clipboard.SetDataObject(data, True)
Else
    ' Place the non-persisted data on the clipboard.
    Clipboard.SetDataObject(data, False)
End If

' If you keep a copy of the source data object, you can use the IsCurrent method to see if
' the data object is still on the clipboard.
Dim isOriginalDataObject As Boolean = Clipboard.IsCurrent(data)

Комментарии

DataObject предоставляет базовую реализацию IDataObject интерфейса . IsCurrent определяет объект данных, ранее помещенный в буфер обмена при последнем SetDataObject вызове.

См. также раздел

• GetDataObject()