KeyboardEvent: initKeyEvent() メソッド

警告: このメソッドを使わないでください。代わりに KeyboardEvent() コンストラクターを使用してください。

このメソッドは DOM 仕様から削除され、現在のどのブラウザーも対応していません。 Firefox はバージョン 93 からこのメソッドを環境設定 (dom.keyboardevent.init_key_event.enabled) に隠蔽しており、その後まもなく削除される予定になっています。

非推奨: この機能は非推奨になりました。まだ対応しているブラウザーがあるかもしれませんが、すでに関連するウェブ標準から削除されているか、削除の手続き中であるか、互換性のためだけに残されている可能性があります。使用を避け、できれば既存のコードは更新してください。このページの下部にある互換性一覧表を見て判断してください。この機能は突然動作しなくなる可能性があることに注意してください。

KeyboardEvent.initKeyEvent() メソッドは document.createEvent ("KeyboardEvent") を使用して作成されたイベントの値を初期化するために使用されます。この方法で初期化されるイベントは document.createEvent ("KeyboardEvent") メソッドで作成しておく必要があります。 initKeyEvent() はイベントが配信される前に呼び出して設定する必要があります。

構文

js
initKeyEvent (type, bubbles, cancelable, view,
                    ctrlKey, altKey, shiftKey, metaKey,
                    keyCode, charCode)

引数

type

文字列で、イベントの種類を表します。

bubbles

論理値で、このイベントがイベントチェーンを通してバブリングするかどうかを示します（バブリングを参照）。

cancelable

論理値です。イベントがキャンセル可能かどうかを示します（キャンセル可能を参照）。

view

UIEvent.view を指定します。この値は null にすることができます。

ctrlKey

論理値です。 true ならば仮想キーが Ctrl キーとの組み合わせで生成されたことを示します。

altKey

論理値です。 true ならば仮想キーが Alt キーとの組み合わせで生成されたことを示します。

shiftKey

論理値です。 true ならば仮想キーが Shift キーとの組み合わせで生成されたことを示します。

metaKey

論理値です。 true ならば仮想キーが Meta キーとの組み合わせで生成されたことを示します。

keyCode

押されたキーの仮想キーコード値を表す unsigned long で、それ以外は 0 になります。キーコードの一覧は KeyboardEvent.keyCode を参照してください。

charCode

押されたキーに対応する Unicode 文字を表す unsigned long で、それ以外の場合は 0 です。

返値

なし (undefined)。

例

js
const event = document.createEvent("KeyboardEvent"); // create a key event
// define the event
event.initKeyEvent(
  "keypress", // typeArg,
  true, // canBubbleArg,
  true, // cancelableArg,
  null, // viewArg, Specifies UIEvent.view. This value may be null.
  false, // ctrlKeyArg,
  false, // altKeyArg,
  false, // shiftKeyArg,
  false, // metaKeyArg,
  9, // keyCodeArg,
  0,
); // charCodeArg);

document.getElementById("blah").dispatchEvent(event);

仕様書

このキーボードイベントの実装は、 DOM 2 Events の初期版のキーイベント仕様に基づいています。後にこの仕様書から削除され、代わりに KeyboardEvent() を使用するべきとされています。