clipboard API 列表

本模块包含 19 个 API。

Methods(方法)

API 说明 鸿蒙支持
clipboard.readText([type]) 返回 string,即剪贴板中的纯文本内容。 支持
clipboard.writeText(text[, type]) 以纯文本形式将 text 写入剪贴板。 支持
clipboard.readHTML([type]) 返回 string,即剪贴板中的 HTML 标记内容。 支持
clipboard.writeHTML(markup[, type]) 将 HTML 标记写入剪贴板。 支持
clipboard.readImage([type]) 返回 NativeImage,即剪贴板中的图像内容。 支持
clipboard.writeImage(image[, type]) 将图像写入剪贴板。 支持
clipboard.readRTF([type]) 返回 string,即剪贴板中的 RTF 格式内容。 不支持
clipboard.writeRTF(text[, type]) 以 RTF 格式将文本写入剪贴板。 不支持
clipboard.readBookmark() 返回 Object,包含书签的标题和 URL。 不支持
clipboard.writeBookmark(title, url[, type]) 将标题(仅 macOS)和 URL 以书签形式写入剪贴板。 不支持
clipboard.readFindText() 返回 string,即查找粘贴板中的文本,该粘贴板保存当前活跃应用查找面板的状态信息。 不支持
clipboard.writeFindText(text) 以纯文本形式将文本写入查找粘贴板,从渲染进程调用时使用同步 IPC。 不支持
clipboard.clear([type]) 清空剪贴板内容。 不支持
clipboard.availableFormats([type]) 返回 string[],即剪贴板当前类型所支持的格式列表。 支持
clipboard.has(format[, type]) 返回 boolean,表示剪贴板是否支持指定格式。 支持
clipboard.read(format) 返回 string,从剪贴板中读取指定格式的内容。 支持
clipboard.readBuffer(format) 返回 Buffer,从剪贴板中读取指定格式的内容。 支持
clipboard.writeBuffer(format, buffer[, type]) 以指定格式将 buffer 写入剪贴板。 支持
clipboard.write(data[, type]) 将数据写入剪贴板。 支持