HTMLドキュメントのdesignModeが切り替えられた際に、ドキュメントは編集可能領域の内容の操作を実行するexecCommandメソッドからアクセス可能となります。
多くのコマンド(bold、italic等)が、
ドキュメントのセレクション(getSelection参照)に影響を与える一方、
新しい要素を挿入するもの(リンクの追加)、行全体に影響を与える(インデント)ものが存在します。
contentEditable
を使用している場合、
execCommand
呼び出しは現在のアクティブな編集可能要素に影響を与えます。
文法
execCommand(aCommandName, aShowDefaultUI, aValueArgument)
引数 |
説明 |
aCommandName |
型:String
コマンドの名前を指定します。
|
aShowDefaultUI |
型:Boolean
デフォルトのユーザインタフェースが表示されるべきかどうかを指定します。
これはMozillaには実装されていません。
|
aValueArgument |
型:String
コマンド(insertimageのような)によっては、追加で引数(imageのURL)を必要とします。
引数が不要であれば、null を渡してください。
|
コマンド
- backColor
-
ドキュメントの背景色を変更します。
styleWithCssモードでは、代わりにブロックを含む背景色に作用します。
値の引数として色の文字列値を必要とします。
(Internet Explorerは、テキストの背景色の設定にこれを使用します。)
- bold
-
セレクション、または差し込み位置のbold(太字)のオン/オフを切り替えます。
(Internet Explorerは、Bタグの代わりにSTRONGタグを使用します。)
- contentReadOnly
-
コンテンツのドキュメントを、読み込み専用または編集可能のどちらかにします。
これは引数値として、true/falseの真偽値が渡されることを必要とします。
(Internet Explorerは、非対応)
- copy
-
現在のセレクションをクリップボードへコピーします。
クリップボード機能はuser.jsと設定ファイルで有効にする必要があります。
- createLink
-
セレクションがある場合のみ、セレクションからAリンクを作成します。
これは、引数の値として渡されるhrefのURI文字列を必要とします。
URIは空白でも良いので、少なくとも1文字を含むもので無ければいけません。
(Internet Explorerは、URIの値が
null
でもリンクを作成します。)
- cut
-
現在のセレクションをカットし、クリップボードへコピーします。
クリップボード機能はuser.jsと設定ファイルで有効にする必要があります。
- decreaseFontSize
-
SMALLタグをセレクションの周り、または差し込み位置に追加します。
(Internet Explorerは非対応です。)
- delete
-
現在のセレクションの削除します。
- enableInlineTableEditing
-
テーブルの行と列の、挿入と削除の制御の有効・無効を切り替えます。
(Internet Explorerは非対応です。)
- enableObjectResizing
-
画像とその他のリサイズ可能なオブジェクトでの、リサイズ操作を有効または無効にします。
(Internet Explorerは非対応です。)
- fontName
-
セレクションまたは差し込み位置のフォント名を変更します。
フォント名の文字列(例えば、"Arial")が、引数の値として渡される必要があります。
- fontSize
-
セレクションまたは差し込み位置のフォントサイズを変更します。
HTMLのフォントサイズ(1~7)が、引数の値として渡される必要があります。
- foreColor
-
セレクションまたは差し込み位置のフォント色を変更します。
色の値の文字列が、引数の値として渡される必要があります。
- formatBlock
-
HTMLのブロックスタイルのタグを、現在のセレクションを含む行を囲む部分に追加し、
もし行に含まれるブロック要素があれば、それを置き換えます。
(FirefoxではBLOCKQUOTEは特例として、何らかのブロック要素で囲まれます)
引き数値として渡されるタグ名の文字列が必要とされます。
事実上、全てのブロックのスタイルタグが使用可能です。(例: "H1"、"P"、"DL"、"BLOCKQUOTE")
(Internet Explorerは、ヘッドタグであるH1~H6、ADDRESS、PREのみをサポートし、
また"<H1>のような、タグ区切り< >を含めなければいけません)
- forwardDelete
-
カーソルの位置の先頭の文字を削除します。
これは、削除キーの打ち込みと同じになります。
- heading
-
ヘッドタグをセレクションの周り、または差し込み位置の行に追加します。
引数の値として渡される、タグ名の文字列が必要とされます。(例: "H1"、"H6")
(Internet Explorerではサポートされません。)
- hiliteColor
-
セレクションまたは差し込み位置の背景色を変更します。
引数の値として渡される色の文字列が必要とされます。
UseCSSは、このために機能をONにする必要があります。
(Internet Explorerではサポートされません。)
- increaseFontSize
-
セレクションの周りまたは差し込み位置にBIGタグを追加します。
(Internet Explorerではサポートされません。)
- indent
-
セレクション、または差し込み位置を含む行をインデントします。
Firefoxでは、セレクションが階層の異なるインデントに対して複数行にまたがる場合、
セレクション内で最小のインデントの行だけがインデントされます。
- insertBrOnReturn
-
Enterキーがbrタグを挿入、または現在のブロック要素を2つに分割するか否かを制御します。
(Internet Explorerではサポートされません。)
- insertHorizontalRule
-
差し込み位置に、水平線を挿入します。(セレクションは削除)
- insertHTML
-
差し込み位置に、HTML文字列を挿入します。(セレクションは削除)
引数の値として、正当なHTML文字列が渡される必要があります。
(Internet Explorerではサポートされません。)
- insertImage
-
差し込み位置に画像を挿入します。(セレクションを削除)
引数の値として画像のsrcのURI文字列が渡される必要があります。
URIは空白でも良いので、少なくとも1文字を含むもので無ければいけません。
(Internet Explorerは、URIの値が
null
でもリンクを作成します。)
- insertOrderedList
-
セレクションまたは挿入位置に、番号付きの順序リスト(<OL>)を作成します。
- insertUnorderedList
-
セレクションまたは挿入位置に、番号無しの箇条書きリスト(<UL>)を作成します。
- insertParagraph
-
セレクション、または現在の行を囲うように、段落(<P>)を挿入します。
(Internet Explorerは差し込み位置に段落を挿入し、セレクションを削除します。)
- insertText
-
差し込み位置にプレーンテキストを挿入します。(セレクションは削除)
- italic
-
セレクションまたは差し込み位置のイタリック書体のon/offを切り替えます。
(Internet Explorerは、<I>の代わりに、<EM>タグを使用します。)
- justifyCenter
-
セレクションまたは差し込み位置を中央揃えにします。
- justifyFull
-
セレクションまたは差し込み位置を均等割付にします。
- justifyLeft
-
セレクションまたは差し込み位置を左揃えにします。
- justifyRight
-
セレクションまたは差し込み位置を右揃えにします。
- outdent
-
セレクションまたは差し込み位置を含む行をアウトデントします。
- paste
-
差し込み位置にクリップボードの内容を貼り付けます。(または、現在のセレクションと置き換えます。)
クリップボード機能はuser.jsと設定ファイルで有効にする必要があります。
- redo
-
直前のundoコマンドをやり直します。
- removeFormat
-
現在のセレクションから、フォーマットを全て削除します。
- selectAll
-
編集可能領域のコンテンツ全てを選択します。
- strikeThrough
-
セレクションまたは差し込み位置で、取り消し線のオン/オフを切り替えます。
- subscript
-
セレクションまたは差し込み位置で、下付き文字のオン/オフを切り替えます。
- superscript
-
セレクションまたは差し込み位置で、上付き文字のオン/オフを切り替えます。
- underline
-
セレクションまたは差し込み位置で、下線のオン/オフを切り替えます。
- undo
-
最後の実行コマンドを取り消します。
- unlink
-
選択したAリンクのAタグを削除します。
- useCSS(非推奨)
-
生成されたマークアップのHTMLタグまたはCSSの使用を切り替えます。
引数の値として、true/falseの真偽値を必要とします。
注意: この引数は必然的に後方互換となっています。(falseはCSSを使用、trueはHTMLを使用)
(Internet Explorerではサポートされません。)
これは非推奨になっているため、代わりにstyleWithCSSコマンドを使用してください。
- styleWithCSS
-
useCSSコマンドに置き換わるもので、引数が期待通りに動作するものです。
すなわち、trueの場合はマークアップ内のスタイル属性の変更/生成を行い、
falseはフォーマット要素を生成します。
ブラウザ互換性
デスクトップ
機能 |
Chrome |
Firefox (Gecko) |
IE |
Opera |
Safari |
基本 |
◯ |
◯ |
? |
? |
◯ |
モバイル
機能 |
Android |
Firefox Mobile |
IE Mobile |
Opera Mobile |
Safari Mobile |
基本 |
? |
◯ |
? |
? |
? |
仕様
注意事項
Back to top
© 2017 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
このページは、ページトップのURL先のMozilla Developer Network(以下、MDN)のコンテンツを翻訳した内容を基に構成されています。
構成について異なる点も含まれますので、下記の項目を確認し、必要に応じて元のコンテンツをご確認ください。
もし、誤訳などの間違いを見つけましたら、 @tomofまで教えていただければ幸いです。
-
特定のブラウザに特化しすぎている情報やあまりにも古い情報、
または試験的に導入されているようなAPIや機能については、省略していることがあります。
-
例やデモについて、実際にページ内で動作させる関係で一部ソースコードを変更している場合や、
その例で使用しているコンテンツの単語や文章などを日本人向けに変更しいてる場合があります。
-
MDNの更新頻度が高いため、元のコンテンツと比べ情報が古くなっている可能性があります。
-
"訳注:"などの断わりを入れた上で、日本人向けの情報の追記を行っている事があります。