Cette page a été traduite à partir de l'anglais par la communauté.Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.
document.execCommand
Obsolète: Cette fonctionnalité n'est plus recommandée. Même si certains navigateurs la prennent encore en charge, elle a peut-être déjà été supprimée des standards du web, est en passe d'être supprimée ou n'est conservée qu'à des fins de compatibilité. Évitez de l'utiliser et mettez à jour le code existant si possible ; consultez letableau de compatibilité au bas de cette page pour vous aider à prendre votre décision. Sachez que cette fonctionnalité peut cesser de fonctionner à tout moment.
Lorsqu'un document HTML passe endesignMode, l'objetdocument correspondant expose une méthodeexecCommand() permettant d'exécuter des commandes manipulant la région éditable courante tels queles champs de formulaire ou les élémentscontentEditable.
La plupart des commandes affectent lasélection du document (mise en gras, italique, etc.), tandis qued'autres insèrent de nouveaux éléments (un lien) ou modifient toute une ligne (indentation). Lorsqu'onutilisecontentEditable,execCommand() affecte l'élément éditablecourant.
Dans cet article
Syntaxe
document.execCommand(aCommandName, aShowDefaultUI, aValueArgument);Valeur de retour
Un booléen (Boolean) qui vautfalse si la commande n'est pasprise en charge ou si elle est désactivée.
Note :document.execCommand() ne renvoietrue que s'il est appelé à partir d'une interaction utilisateur. On nepeut pas l'invoquer dans un script afin de vérifier la prise en charge navigateur avantd'appeler une commande. À partir de Firefox 82, les appels imbriqués àdocument.execCommand() renverront toujoursfalse.
Paramètres
aCommandNameUne chaîne de caractères
DOMStringindiquant le nom de la commande àexécuter. VoirCommandes pour une liste de commandes possibles.aShowDefaultUIUn booléen (
Boolean) indiquant si l'interface utilisateur par défautdevrait être affichée. Ce n'est pas implémenté par Mozilla.aValueArgumentPour les commandes utilisant un argument en entrée, il s'agit d'une chaîne
DOMStringqui fournit cette information. On pourra, par exemple,insertImageutilisel'URL de l'image à insérer. On utiliseranullsi aucun argument n'est utilisé.
Commandes
backColorModifie la couleur d'arrière-plan du document. Avec le mode
styleWithCsscela affecte la couleur d'arrière-plan du bloc englobant. Une chaîne de caractères décrivant une valeur<color>doit être passée en argument. On notera qu'Internet Explorer utilise ceci pour la couleur d'arrière-plan du texte.boldActive ou désactive la mise en gras pour la sélection ou à partir du point d'insertion Internet Explorer utilise la balise
<strong>plutôt que<b>.ClearAuthenticationCacheSupprime toutes les informations d'authentificationcredentials) du cache.
contentReadOnlyRend le contenu du document en lecture seule ou éditable en fonction du booléen passé en argument (n'est pas pris en charge par Internet Explorer)
copyCopie la sélection courante vers le presse-papier. Les conditions pour obtenir ce comportement peuvent varier d'un navigateur à l'autre. Veuillez voir le tableau de compatibilité ci-après.
createLinkCrée un hyperlien à partir de la sélection (sous réserve qu'il y en ait une). Une chaîne de caractères formant un URI est nécessaire comme argument afin de fournir la valeur de l'attribut
href. L'URI doit contenir au moins un caractère (qui peut être un blanc). (Internet Explorer créera un lien avec une valeurnull.)cutCoupe le contenu de la sélection courante et le copie dans le presse-papier. Les conditions pour obtenir ce comportement peuvent varier d'un navigateur à l'autre. Veuillez voir le tableau de compatibilité ci-après.
decreaseFontSizeAjoute une balise
<small>autour de la sélection ou au point d'insertion. (Non pris en charge par Internet Explorer.)defaultParagraphSeparatorModifie le séparateur de paragraphe utilisé lorsque de nouveaux paragraphes sont créés dans les zones de texte éditables. VoirDifférences dans la génération du balisage pour plus de détails.
deleteSupprimer la sélection courante.
enableAbsolutePositionEditorActive ou désactive la poignée qui permet de déplacer les éléments positionnés de façon absolue. Celle-ci est désactivée par défaut depuis Firefox 64 (bug Firefox 1490641).
enableInlineTableEditingActive ou désactive les contrôles pour l'insertion ou la suppression des lignes ou colonnes de tableau. Les contrôles sont désactivés par défaut depuis Firefox 64 (bug Firefox 1490641).
enableObjectResizingActive ou désactive les contrôles permettant de redimensionner les images, tableaux ou les éléments positionnés de façon absolue. Les poignées sont désactivées par défaut depuis Firefox 64 (bug Firefox 1490641).
fontNameModifie le nom de la police pour la sélection ou à partir du point d'insertion. La valeur fournie en argument doit être un nom de police (ex.
"Arial").fontSizeModifie la taille de la police pour la sélection ou à partir du point d'insertion. La valeur fournie en argument doit être un entier compris entre 1 et 7.
foreColorModifie la couleur de la police pour la sélection ou à partir du point d'insertion. La valeur passée en argument doit être une chaîne de caractères décrivant une couleur exprimée en notation hexadécimale.
formatBlockAjoute un élément HTML de bloc autour de la ligne contenant la sélection courante et remplace l'éventuel élément de bloc englobant s'il en existe un (pour Firefox,
<blockquote>fera exception et englobera n'importe quel bloc). L'argument passé doit être un nom de balise. Tous les éléments de bloc peuvent en théorie être utilisés. (Internet Explorer et Edge ne prennent en charge que les balisesH1àH6,ADDRESS, etPREqui doivent être passées entre chevrons :"<H1>".)forwardDeleteSupprime un caractère à la position du curseur. Le comportement obtenu est le même que lorsqu'on appuie sur la toucheSuppr d'un clavier Windows.
headingAjoute un élément de titre autour de la sélection ou au niveau du point d'insertion. L'argument doit être le nom d'une balise de titre (
"H1"à"H6"). (Non pris en charge par Internet Explorer et Safari.)hiliteColorModifie la couleur d'arrière-plan pour la sélection ou à partir du point d'insertion. La valeur passée en argument doit être une chaîne de caractères définissant une couleur et
useCSSdoit valoirtrue. (Non pris en charge par Internet Explorer.)increaseFontSizeAjoute une balise
<big>autour de la sélection ou à partir du point d'insertion. (Non pris en charge par Internet Explorer).indentAugmente l'indentation de la ligne contenant la sélection ou le point d'insertion. Pour Firefox, si la sélection s'étend sur plusieurs lignes ayant différents niveaux d'indentation, seules les lignes les moins indentées seront décalées.
insertBrOnReturnContrôle si la toucheEntrée insère un élément
<br>ou si le bloc courant est scindé en deux. (Non pris en charge par Internet Explorer.)insertHorizontalRuleInsère un élément
<hr>au point d'insertion ou remplace la sélection courante par cet élément.insertHTMLInsère un élément au point d'insertion en supprimant la sélection. Une chaîne de caractères HTML valide doit être fournie en argument. (Non pris en charge par Internet Explorer.)
insertImageInsère une image au point d'insertion en supprimant la sélection. L'argument doit être une chaîne de caractères indiquant l'URL à utiliser pour l'attribut
srcde l'image. Les prérequis de cette valeur sont les mêmes que pourcreateLink.insertOrderedListCrée uneliste numérotée ordonnée pour la sélection ou à partir du point d'insertion.
insertUnorderedListCrée uneliste non-ordonnée pour la sélection ou à partir du point d'insertion.
insertParagraphInsère unparagraphe autour de la sélection pour la ligne courante. (Internet Explorer insère un paragraphe au point d'insertion et supprime la sélection.)
insertTextInsère le texte indiqué au point d'insertion (quitte à supprimer l'éventuelle sélection courante).
italicActive ou désactive la mise en italique pour la sélection ou à partir du point d'insertion. (Internet Explorer utilisera l'élément
<em>plutôt que<i>.)justifyCenterCentre la sélection ou le point d'insertion.
justifyFullJustifie la sélection ou le point d'insertion.
justifyLeftJustifie à gauche la sélection ou le point d'insertion.
justifyRightJustifie à droite la sélection ou le point d'insertion.
outdentEffectue un retrait d'indentation pour la ligne courante.
pasteColle le contenu du presse-papier au point d'insertion (et remplace éventuellement la sélection actuelle). Fonctionnalité désactivée pour le contenu web.
redoRejoue l'action annulée par la précédente commande
undo.removeFormatSupprime toute mise en forme pour la sélection courante.
selectAllSélectionne l'ensemble du contenu de la région éditable.
strikeThroughActive ou désactive la rayure de la sélection ou à partir d'un point d'insertion.
subscriptActive ou désactivela mise en indice pour la sélection ou au point d'insertion
superscriptActive ou désactivela mise en exposant pour la sélection ou au point d'insertion
underlineActive ou désactivele soulignement pour la sélection ou au point d'insertion.
undoAnnule la dernière commande exécutée.
unlinkRetire l'ancre de l'hyperlien sélectionné.
useCSSObsolèteActive/désactive l'utilisation de balises HTML ou de CSS pour le balisage généré. La valeur de l'argument doit être un booléen. Note : cet argument possède une logique inversée (
falsepermet d'utiliser CSS ettruepermet d'utiliser HTML). Cette valeur n'est pas prise en charge par Internet Explorer et a été dépréciée en faveur destyleWithCSS.styleWithCSSRemplace la commande
useCSS.truemodifie/génère des attributsstyledans le balisage tandis quefalsegénère des éléments HTML de présentation.
Exemple
Un exemple d'utilisation est disponiblesur CodePen.
Spécifications
This feature does not appear to be defined in any specification.>Compatibilité des navigateurs
Voir aussi
HTMLElement.contentEditabledocument.designMode- L'édition HTML dans Firefox
- Documentation des incohérencesnavigateur dans Scribe qui indique les bugs liés à
document.execCommand.