← Toute la documentation

editor.execCommand(command, value)

Exécute une commande de l’éditeur, par son nom, sur la sélection courante — les mêmes commandes que celles qu’invoquent les boutons de la barre d’outils. C’est le principal moyen de piloter l’éditeur depuis vos propres boutons, raccourcis clavier ou automatisations : mise en forme (bold, forecolor), insertion (insertimage, inserttable), changements d’affichage (fullscreenenter), et bien d’autres.

Syntaxe

editor.execCommand(command, value)

Paramètres

command — le nom de la commande (insensible à la casse). Consultez toutes les commandes pour la liste complète.

value — facultatif. Certaines commandes ont besoin d’une valeur — par exemple forecolor prend une couleur, et formatblock une balise comme h2.

Valeur renvoyée

false lorsque la commande est désactivée ou bloquée ; sinon, la commande s’exécute.

Remarques sur le comportement

  • Les noms de commandes sont insensibles à la casse. Ils sont mis en minuscules en interne : Bold et bold se comportent donc de la même façon.
  • Les commandes désactivées sont ignorées. Si une commande n’est pas activée à ce moment-là, execCommand() renvoie false sans agir — vérifiez d’abord isCommandEnabled() si vous devez le savoir à l’avance.
  • Chaque commande peut être interceptée. Avant l’exécution, l’éditeur déclenche un événement exec_command (et un événement propre à la commande, exec_command_<name>) ; renvoyer une valeur depuis votre gestionnaire remplace le comportement intégré.

Exemple d’utilisation

Basculer une commande d’affichage :

var editor1 = new RichTextEditor("#div_editor1");
editor1.execCommand("fullscreenenter");

Exécuter une commande qui a besoin d’une valeur :

editor1.execCommand("forecolor", "red");
editor1.execCommand("formatblock", "h2");

Relier un bouton personnalisé à une commande de mise en forme :

document.getElementById("btn_bold").onmousedown = function (e) {
    e.preventDefault();            // keep focus in the editor
    editor1.execCommand("bold");
};

Voir aussi