electron/docs-translations/jp/api/clipboard.md
2016-01-18 23:38:44 +09:00

2.8 KiB

clipboard

clipboardモジュールは、コピーとペースト操作を実行するメソッドを提供します。次の例は、クリップボードに文字列を書き込む方法を示しています:

const clipboard = require('electron').clipboard;
clipboard.writeText('Example String');

X Windowsシステム上では、セレクションクリップボードがあります。それを操作するために、それぞれのメソッドで、selectionを通す必要があります。

clipboard.writeText('Example String', 'selection');
console.log(clipboard.readText('selection'));

メソッド

clipboardモジュールには、次のメソッドがあります:

Note: 実験的APIには、そのようにマークしてあり、将来的には削除される可能性があります。

clipboard.readText([type])

  • type String (optional)

プレーンテキストとしてクリップボードの内容を返します。

clipboard.writeText(text[, type])

  • text String
  • type String (optional)

プレーンテキストとしてクリップボードにtextを書き込みます。

clipboard.readHtml([type])

  • type String (optional)

HTMLマークアップとして、クリップボードの内容を返します。

clipboard.writeHtml(markup[, type])

  • markup String
  • type String (optional)

クリップボードにHTMLマークアップとして書き込みます。

clipboard.readImage([type])

  • type String (optional)

NativeImageとしてクリップボードの内容を返します。

clipboard.writeImage(image[, type])

image としてクリップボードに書き込みます。

clipboard.clear([type])

  • type String (optional)

クリップボードの内容をクリアします。

clipboard.availableFormats([type])

  • type String (optional)

typeのクリップボードがサポートしているフォーマット配列を返します。

clipboard.has(data[, type]) 実験

  • data String
  • type String (optional)

dataで指定したフォーマットをクリップボードがサポートしているかどうかを返します。

console.log(clipboard.has('<p>selection</p>'));

clipboard.read(data[, type]) 実験

  • data String
  • type String (optional)

クリップボードからdataを読み込みます。

clipboard.write(data[, type])

  • data Object
  • type String (optional)
clipboard.write({text: 'test', html: "<b>test</b>"});

クリップボードにdataを書き込みます。