Document：execCommand() 方法

語法

execCommand(commandName, showDefaultUI, valueArgument)

參數

commandName

指定要執行的命令名稱的字串。以下命令被指定：

backColor

更改文件背景顏色。在 styleWithCss 模式下，它會改變包含區塊的背景顏色。這需要傳遞一個 <color> 值字串作為引數值。

bold

切換選取範圍或插入點的粗體開／關。

contentReadOnly

使內容文件變為唯讀或可編輯。這需要一個布林值 true／false 作為引數值。

copy

將當前選取範圍複製到剪貼簿。此行為的啟用條件因瀏覽器而異，並隨時間演變。請檢查相容性表以確定是否可以在你的情況下使用。

createLink

從選取範圍創建一個超連結，但僅在有選取範圍時才有效。需要一個 URI 字串作為超連結 href 的引數值。URI 必須至少包含一個字元，可以是空白字元。

cut

移除當前選取範圍並將其複製到剪貼簿。此行為的啟用時間因瀏覽器而異，其條件也隨時間演變。請檢查相容性表以獲取使用細節。

decreaseFontSize

在選取範圍或插入點周圍添加一個 <small> 標籤。

defaultParagraphSeparator

更改在可編輯文字區域中創建新段落時使用的段落分隔符。

delete

刪除當前選取範圍。

enableAbsolutePositionEditor

啟用或停用允許絕對定位元素移動的抓取器。從 Firefox 64 開始，抓取器預設為停用（Firefox bug 1490641）。

enableInlineTableEditing

啟用或停用表格列／欄插入和刪除控制項。從 Firefox 64 開始，控制項預設為停用（Firefox bug 1490641）。

enableObjectResizing

啟用或停用圖像、表格、絕對定位元素和其他可調整大小物件上的調整大小控制點。從 Firefox 64 開始，控制點預設為停用（Firefox bug 1490641）。

fontName

更改選取範圍或插入點的字體名稱。這需要一個字體名稱字串（例如 "Arial"）作為引數值。

fontSize

更改選取範圍或插入點的字體大小。這需要一個從 1 到 7 的整數作為引數值。

foreColor

更改選取範圍或插入點的字體顏色。這需要一個十六進位顏色值字串作為引數值。

formatBlock

在包含當前選取範圍的行周圍添加一個 HTML 區塊級元素，若存在則替換包含該行的區塊元素（在 Firefox 中，<blockquote> 是例外——它會包裹任何包含的區塊元素）。需要一個標籤名稱字串作為引數值。幾乎所有區塊級元素都可以使用。（舊版 Edge 僅支援標題標籤 H1 – H6、ADDRESS 和 PRE，這些標籤必須用尖括號包裹，例如 "<H1>"。）

forwardDelete

刪除游標位置前的字元，與按下 Windows 鍵盤上的 Delete 鍵相同。

heading

在選取範圍或插入點行周圍添加一個標題元素。需要標籤名稱字串作為引數值（例如 "H1"、"H6"）。(Safari 不支援。)

highlightColor

更改選取範圍或插入點的背景顏色。需要一個顏色值字串作為引數值。useCSS 必須為 true 才能運作。

increaseFontSize

在選取範圍或插入點周圍添加一個 <big> 標籤。

indent

縮排包含選取範圍或插入點的行。在 Firefox 中，如果選取範圍跨越多行且縮排層級不同，則僅會縮排選取範圍中縮排最少的行。

insertBrOnReturn

控制 Enter 鍵是插入 <br> 元素，還是將當前區塊元素分成兩個。

insertHorizontalRule

在插入點插入一個 <hr> 元素，或用它取代選取範圍。

insertHTML

在插入點插入一個 TrustedHTML 實例或 HTML 標記字串（刪除選取範圍）。這需要有效的 HTML 標記。

警告：輸入會被解析為 HTML 並寫入 DOM 中。像這樣的 API 被稱為注入匯點，如果輸入最初來自攻擊者，可能會成為跨站腳本（XSS）攻擊的載體。

你可以透過始終指派 TrustedHTML 物件而非字串，並強制執行可信任類型來減輕此風險。更多資訊請參見 Trusted Types API。

insertImage

在插入點插入一個圖像（刪除選取範圍）。需要一個圖像 src 的 URL 字串作為引數值。此字串的要求與 createLink 相同。

insertOrderedList

為選取範圍或插入點創建一個編號的有序列表。

insertUnorderedList

為選取範圍或插入點創建一個帶點的無序列表。

insertParagraph

在選取範圍或當前行周圍插入一個段落。

insertText

在插入點插入給定的純文字（刪除選取範圍）。

italic

切換選取範圍或插入點的斜體開／關。

justifyCenter

將選取範圍或插入點置中。

justifyFull

將選取範圍或插入點對齊。

justifyLeft

將選取範圍或插入點向左對齊。

justifyRight

將選取範圍或插入點向右對齊。

outdent

凸排包含選取範圍或插入點的行。

paste

在插入點貼上剪貼簿內容（取代當前選取範圍）。對於 Web 內容不可用。

redo

重做上一個撤銷命令。

removeFormat

移除當前選取範圍的所有格式。

selectAll

選取可編輯區域的所有內容。

strikeThrough

切換選取範圍或插入點的刪除線開／關。

subscript

切換選取範圍或插入點的下標開／關。

superscript

切換選取範圍或插入點的上標開／關。

underline

切換選取範圍或插入點的底線開／關。

undo

撤銷最後執行的命令。

unlink

從選取的超連結中移除錨點元素。

useCSS

切換生成標記時使用 HTML 標籤或 CSS。需要一個布林值 true/false 作為引數值。

備註：此參數在邏輯上是反向的（即，使用 false 表示使用 CSS，使用 true 表示使用 HTML）。此功能已被 styleWithCSS 取代。

styleWithCSS

取代 useCSS 命令。true 修改／生成標記中的 style 屬性，false 生成展示用元素。

AutoUrlDetect

更改瀏覽器的自動連結行為。

showDefaultUI

一個布林值，指示是否應顯示預設的使用者介面。Mozilla 中未實作此功能。

valueArgument

對於需要輸入引數的命令，是一個提供該資訊的字串。例如，insertImage 需要插入圖像的 URL。若不需要引數，請指定 null。

回傳值

一個布林值，若命令不支援或已停用則為 false。

範例

使用 insertText

此範例展示了兩個非常基本的 HTML 編輯器，一個使用 <textarea> 元素，另一個使用帶有 contenteditable 屬性的 <pre> 元素。

點擊「粗體」或「斜體」按鈕會在元素中插入相應的標籤，使用 insertText 來保留編輯歷史，因此使用者可以撤銷操作。

HTML

<h2>textarea</h2>

<div class="actions" data-for="textarea">
  <button data-el="b">粗體</button>
  <button data-el="i">斜體</button>
</div>

<textarea class="editarea">一些文字。</textarea>

<h2>contenteditable</h2>

<div class="actions" data-for="pre">
  <button data-el="b">粗體</button>
  <button data-el="i">斜體</button>
</div>

<pre contenteditable="true" class="editarea">一些文字。</pre>

JavaScript

// 準備操作按鈕
const buttonContainers = document.querySelectorAll(".actions");

for (const buttonContainer of buttonContainers) {
  const buttons = buttonContainer.querySelectorAll("button");
  const pasteTarget = buttonContainer.getAttribute("data-for");

  for (const button of buttons) {
    const elementName = button.getAttribute("data-el");
    button.addEventListener("click", () =>
      insertText(`<${elementName}></${elementName}>`, pasteTarget),
    );
  }
}

// 在游標處插入文字，或取代選取的文字
function insertText(newText, selector) {
  const textarea = document.querySelector(selector);
  textarea.focus();

  let pasted = true;
  try {
    if (!document.execCommand("insertText", false, newText)) {
      pasted = false;
    }
  } catch (e) {
    console.error("捕獲的錯誤：", e);
    pasted = false;
  }

  if (!pasted) {
    console.error("貼上失敗，execCommand 不支援");
  }
}

結果

規範

此功能不屬於任何當前的規範。它已不再計畫成為標準。存在一份非官方的 W3C execCommand 規範草案。

瀏覽器相容性

參見

• Clipboard API
• MDN 範例：你的瀏覽器支援的 execCommand
• HTMLElement.contentEditable
• document.designMode
• document.queryCommandEnabled()
• document.queryCommandState()
• document.queryCommandSupported()