Clipboard Класс

Определение

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

Windows.ApplicationModel.DataTransfer

Возвращает и задает сведения из объекта буфера обмена.

public ref class Clipboard abstract sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class Clipboard final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public static class Clipboard

Public Class Clipboard

Наследование

Object Platform::Object IInspectable Clipboard

Атрибуты

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Требования к Windows

Семейство устройств	Windows 10 (появилось в 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (появилось в v1.0)

Примеры

В следующем примере показано, как отслеживать изменения в буфере обмена. Если буфер обмена содержит текст, код добавляет его на HTML-страницу.

private async void TrackClipboardChanges_EventHandler(object sender, object e)
{
    DataPackageView dataPackageView = Clipboard.GetContent();
    if (dataPackageView.Contains(StandardDataFormats.Text))
    {
        String text = await dataPackageView.GetTextAsync();

        // To output the text from this example, you need a TextBlock control
        // with a name of "TextOutput".
        TextOutput.Text = "Clipboard now contains: " + text;
    }
}

Совет

Дополнительные сведения, руководство по проектированию и примеры кода см. в разделе Копирование и вставка.

Откройте приложение коллекции WinUI 3 и ознакомьтесь с разделом Функции буфера обмена в действии.

Приложение коллекции WinUI 3 содержит интерактивные примеры большинства элементов управления, функций и функций WinUI 3. Получение приложения из Microsoft Store или получение исходного кода на GitHub

Комментарии

Так как класс Clipboard является статическим, вам не нужно создавать его экземпляр для доступа к его методам.

Доступ к буферу обмена можно получить только в том случае, если вызывающее приложение находится в фокусе на потоке пользовательского интерфейса (например, если его CoreWindow активен). Используйте событие CoreWindow.Activated для отслеживания состояния вызывающего приложения.

Журнал версий

Версия Windows	Версия пакета SDK	Добавленная стоимость
1809	17763	ClearHistory
1809	17763	DeleteItemFromHistory
1809	17763	GetHistoryItemsAsync
1809	17763	HistoryChanged
1809	17763	HistoryEnabledChanged
1809	17763	IsHistoryEnabled
1809	17763	IsRoamingEnabled
1809	17763	RoamingEnabledChanged
1809	17763	SetContentWithOptions
1809	17763	SetHistoryItemAsContent

Методы

Clear()	Удаляет все данные из буфера обмена.
ClearHistory()	Очищает журнал буфера обмена.
DeleteItemFromHistory(ClipboardHistoryItem)	Удаляет указанный элемент из журнала буфера обмена.
Flush()	Добавляет содержимое в буфер обмена и освобождает объект DataPackage из исходного приложения. Этот метод позволяет содержимому оставаться доступным после завершения работы приложения.
GetContent()	Возвращает текущее содержимое, хранящееся в объекте буфера обмена.
GetHistoryItemsAsync()	Возвращает список элементов, которые в настоящее время находятся в журнале буфера обмена.
IsHistoryEnabled()	Указывает, включен ли журнал буфера обмена (т. е. возможность сохранения нескольких элементов в буфере обмена) для текущего пользователя.
IsRoamingEnabled()	Указывает, настроена ли синхронизация данных буфера обмена между устройствами для текущего пользователя.
SetContent(DataPackage)	Задает текущее содержимое, хранящееся в объекте буфера обмена.
SetContentWithOptions(DataPackage, ClipboardContentOptions)	Задает содержимое, хранящееся в объекте буфера обмена, с параметрами для содержимого.
SetHistoryItemAsContent(ClipboardHistoryItem)	Задает элемент в журнале буфера обмена в качестве текущего содержимого для буфера обмена.

События

ContentChanged	Происходит при изменении данных, хранящихся в буфере обмена.
HistoryChanged	Происходит при добавлении нового элемента в журнал буфера обмена.
HistoryEnabledChanged	Происходит при изменении параметра ОС, определяющего, включен ли журнал буфера обмена для текущего пользователя.
RoamingEnabledChanged	Происходит при изменении параметра ОС, определяющего, задана ли синхронизация данных буфера обмена между устройствами для текущего пользователя.

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

• Пример буфера обмена (Windows 10)