clipboard（剪貼板）

在系統剪貼板上執行復制和粘貼操作。

提示：推薦使用 Clipboard Viewer（Win / Mac） 工具進行開發除錯，讓開發過程更順利。

await eagle.clipboard.writeText('Example string');

console.log(await eagle.clipboard.readText());

---

方法

clear()

清除剪貼板內容。

eagle.clipboard.writeText('Example string');
eagle.clipboard.clear();
console.log(eagle.clipboard.readText());	// undefined

---

has(format)

當前剪貼板內容是否包含指定的 format

• format string - 指定格式

• 返回 boolean - 是否包含指定格式

console.log(eagle.clipboard.has('public/utf8-plain-text'));	// false

const buffer = Buffer.from('writeBuffer', 'utf8');
eagle.clipboard.writeBuffer('public/utf8-plain-text', buffer);

console.log(eagle.clipboard.has('public/utf8-plain-text'));	// true

---

writeText(text)

將 text 作為純文字寫入剪貼板。

• text string - 欲寫入文字

eagle.clipboard.writeText('Example string');
console.log(eagle.clipboard.readText());	// 'Example string'

---

readText()

獲取前當剪貼板的純文字內。

• 返回 string

console.log(await eagle.clipboard.readText());

---

writeBuffer(format, buffer)

將 buffer 作為 format 類型寫入剪貼板。

• format string - 剪貼板格式

• buffer Buffer - 欲寫入內容之 Buffer 格式

const buffer = Buffer.from('writeBuffer', 'utf8');
eagle.clipboard.writeBuffer('public/utf8-plain-text', buffer);

---

readBuffer(format)

從剪貼板中讀取 format 類型的內容。

• 返回 Buffer

const buffer = Buffer.from('this is binary', 'utf8');
eagle.clipboard.writeBuffer('public/utf8-plain-text', buffer);

const out = eagle.clipboard.readBuffer('public/utf8-plain-text');

console.log(buffer.equals(out));	// true

---

writeImage(image)

將 image 寫入剪貼板。

• image NativeImage - 欲寫入剪貼板圖片

let img = nativeImage.createFromPath('path_to_img_file');
eagle.clipboard.writeImage(img);

---

readImage()

從剪貼板中讀取圖片格式內容。

• 返回 NativeImage

let input = nativeImage.createFromPath('path_to_img_file');
eagle.clipboard.writeImage(input);

let output = eagle.clipboard.readImage();

---

writeHTML(markup)

將 markup 作為 HTML 格式寫入剪貼板。

• markup string

eagle.clipboard.writeHTML('<b>Hi</b>');
console.log(eagle.clipboard.readHTML());	// <b>Hi</b>

---

readHTML()

從剪貼板中讀取 HTML 格式內容。

• 返回 string

eagle.clipboard.writeHTML('<b>Hi</b>');
console.log(eagle.clipboard.readHTML());	// <b>Hi</b>

---

copyFiles(paths)

將指定檔案複製到剪貼板，支援檔案管理器粘貼。

• paths strings[] - 欲複製到剪貼板的檔案。

eagle.clipboard.copyFiles([
    'path_to_file',
    'path_to_file2'
]);

---