Annotation of html5/spec-author-view/editing-apis.html, revision 1.5
1.1 mike 1: <!doctype html>
1.2 mike 2: <html lang="en-US-x-Hixie"><meta content="text/html; charset=utf-8" http-equiv="Content-Type"><title>7.8 Editing APIs — HTML5: Edition for Web Authors</title><link href="whatwg.css" rel="stylesheet"><style type="text/css">
1.1 mike 3: pre { margin-left: 2em; white-space: pre-wrap; }
4: h2 { margin: 3em 0 1em 0; }
5: h3 { margin: 2.5em 0 1em 0; }
6: h4 { margin: 2.5em 0 0.75em 0; }
7: h5, h6 { margin: 2.5em 0 1em; }
8: h1 + h2, h1 + h2 + h2 { margin: 0.75em 0 0.75em; }
9: h2 + h3, h3 + h4, h4 + h5, h5 + h6 { margin-top: 0.5em; }
10: p { margin: 1em 0; }
11: hr:not(.top) { display: block; background: none; border: none; padding: 0; margin: 2em 0; height: auto; }
12: dl, dd { margin-top: 0; margin-bottom: 0; }
13: dt { margin-top: 0.75em; margin-bottom: 0.25em; clear: left; }
14: dt + dt { margin-top: 0; }
15: dd dt { margin-top: 0.25em; margin-bottom: 0; }
16: dd p { margin-top: 0; }
17: dd dl + p { margin-top: 1em; }
18: dd table + p { margin-top: 1em; }
19: p + * > li, dd li { margin: 1em 0; }
20: dt, dfn { font-weight: bold; font-style: normal; }
1.4 mike 21: i, em { font-style: italic; }
1.1 mike 22: dt dfn { font-style: italic; }
23: pre, code { font-size: inherit; font-family: monospace; font-variant: normal; }
24: pre strong { color: black; font: inherit; font-weight: bold; background: yellow; }
25: pre em { font-weight: bolder; font-style: normal; }
26: @media screen { code { color: orangered; } code :link, code :visited { color: inherit; } }
27: var sub { vertical-align: bottom; font-size: smaller; position: relative; top: 0.1em; }
28: table { border-collapse: collapse; border-style: hidden hidden none hidden; }
29: table thead, table tbody { border-bottom: solid; }
30: table tbody th:first-child { border-left: solid; }
31: table tbody th { text-align: left; }
32: table td, table th { border-left: solid; border-right: solid; border-bottom: solid thin; vertical-align: top; padding: 0.2em; }
33: blockquote { margin: 0 0 0 2em; border: 0; padding: 0; font-style: italic; }
34:
35: .bad, .bad *:not(.XXX) { color: gray; border-color: gray; background: transparent; }
36: .matrix, .matrix td { border: none; text-align: right; }
37: .matrix { margin-left: 2em; }
38: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
39: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
40: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
41:
42: .toc dfn, h1 dfn, h2 dfn, h3 dfn, h4 dfn, h5 dfn, h6 dfn { font: inherit; }
43: img.extra { float: right; }
44: pre.idl { border: solid thin; background: #EEEEEE; color: black; padding: 0.5em 1em; }
45: pre.idl :link, pre.idl :visited { color: inherit; background: transparent; }
46: pre.css { border: solid thin; background: #FFFFEE; color: black; padding: 0.5em 1em; }
47: pre.css:first-line { color: #AAAA50; }
48: dl.domintro { color: green; margin: 2em 0 2em 2em; padding: 0.5em 1em; border: none; background: #DDFFDD; }
49: hr + dl.domintro, div.impl + dl.domintro { margin-top: 2.5em; margin-bottom: 1.5em; }
50: dl.domintro dt, dl.domintro dt * { color: black; text-decoration: none; }
51: dl.domintro dd { margin: 0.5em 0 1em 2em; padding: 0; }
52: dl.domintro dd p { margin: 0.5em 0; }
53: dl.switch { padding-left: 2em; }
54: dl.switch > dt { text-indent: -1.5em; }
55: dl.switch > dt:before { content: '\21AA'; padding: 0 0.5em 0 0; display: inline-block; width: 1em; text-align: right; line-height: 0.5em; }
56: dl.triple { padding: 0 0 0 1em; }
57: dl.triple dt, dl.triple dd { margin: 0; display: inline }
58: dl.triple dt:after { content: ':'; }
59: dl.triple dd:after { content: '\A'; white-space: pre; }
60: .diff-old { text-decoration: line-through; color: silver; background: transparent; }
61: .diff-chg, .diff-new { text-decoration: underline; color: green; background: transparent; }
62: a .diff-new { border-bottom: 1px blue solid; }
63:
64: h2 { page-break-before: always; }
65: h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
66: h1 + h2, hr + h2.no-toc { page-break-before: auto; }
67:
68: p > span:not([title=""]):not([class="XXX"]):not([class="impl"]):not([class="note"]),
69: li > span:not([title=""]):not([class="XXX"]):not([class="impl"]):not([class="note"]), { border-bottom: solid #9999CC; }
70:
71: div.head { margin: 0 0 1em; padding: 1em 0 0 0; }
72: div.head p { margin: 0; }
73: div.head h1 { margin: 0; }
74: div.head .logo { float: right; margin: 0 1em; }
75: div.head .logo img { border: none } /* remove border from top image */
76: div.head dl { margin: 1em 0; }
77: div.head p.copyright, div.head p.alt { font-size: x-small; font-style: oblique; margin: 0; }
78:
79: body > .toc > li { margin-top: 1em; margin-bottom: 1em; }
80: body > .toc.brief > li { margin-top: 0.35em; margin-bottom: 0.35em; }
81: body > .toc > li > * { margin-bottom: 0.5em; }
82: body > .toc > li > * > li > * { margin-bottom: 0.25em; }
83: .toc, .toc li { list-style: none; }
84:
85: .brief { margin-top: 1em; margin-bottom: 1em; line-height: 1.1; }
86: .brief li { margin: 0; padding: 0; }
87: .brief li p { margin: 0; padding: 0; }
88:
89: .category-list { margin-top: -0.75em; margin-bottom: 1em; line-height: 1.5; }
90: .category-list::before { content: '\21D2\A0'; font-size: 1.2em; font-weight: 900; }
91: .category-list li { display: inline; }
92: .category-list li:not(:last-child)::after { content: ', '; }
93: .category-list li > span, .category-list li > a { text-transform: lowercase; }
94: .category-list li * { text-transform: none; } /* don't affect <code> nested in <a> */
95:
96: .XXX { color: #E50000; background: white; border: solid red; padding: 0.5em; margin: 1em 0; }
97: .XXX > :first-child { margin-top: 0; }
98: p .XXX { line-height: 3em; }
99: .annotation { border: solid thin black; background: #0C479D; color: white; position: relative; margin: 8px 0 20px 0; }
100: .annotation:before { position: absolute; left: 0; top: 0; width: 100%; height: 100%; margin: 6px -6px -6px 6px; background: #333333; z-index: -1; content: ''; }
101: .annotation :link, .annotation :visited { color: inherit; }
102: .annotation :link:hover, .annotation :visited:hover { background: transparent; }
103: .annotation span { border: none ! important; }
104: .note { color: green; background: transparent; font-family: sans-serif; }
105: .warning { color: red; background: transparent; }
106: .note, .warning { font-weight: bolder; font-style: italic; }
1.4 mike 107: .note em, .warning em, .note i, .warning i { font-style: normal; }
1.1 mike 108: p.note, div.note { padding: 0.5em 2em; }
109: span.note { padding: 0 2em; }
110: .note p:first-child, .warning p:first-child { margin-top: 0; }
111: .note p:last-child, .warning p:last-child { margin-bottom: 0; }
112: .warning:before { font-style: normal; }
113: p.note:before { content: 'Note: '; }
114: p.warning:before { content: '\26A0 Warning! '; }
115:
116: .bookkeeping:before { display: block; content: 'Bookkeeping details'; font-weight: bolder; font-style: italic; }
117: .bookkeeping { font-size: 0.8em; margin: 2em 0; }
118: .bookkeeping p { margin: 0.5em 2em; display: list-item; list-style: square; }
119: .bookkeeping dt { margin: 0.5em 2em 0; }
120: .bookkeeping dd { margin: 0 3em 0.5em; }
121:
122: h4 { position: relative; z-index: 3; }
123: h4 + .element, h4 + div + .element { margin-top: -2.5em; padding-top: 2em; }
124: .element {
125: background: #EEEEFF;
126: color: black;
127: margin: 0 0 1em 0.15em;
128: padding: 0 1em 0.25em 0.75em;
129: border-left: solid #9999FF 0.25em;
130: position: relative;
131: z-index: 1;
132: }
133: .element:before {
134: position: absolute;
135: z-index: 2;
136: top: 0;
137: left: -1.15em;
138: height: 2em;
139: width: 0.9em;
140: background: #EEEEFF;
141: content: ' ';
142: border-style: none none solid solid;
143: border-color: #9999FF;
144: border-width: 0.25em;
145: }
146:
147: .example { display: block; color: #222222; background: #FCFCFC; border-left: double; margin-left: 2em; padding-left: 1em; }
148: td > .example:only-child { margin: 0 0 0 0.1em; }
149:
150: ul.domTree, ul.domTree ul { padding: 0 0 0 1em; margin: 0; }
151: ul.domTree li { padding: 0; margin: 0; list-style: none; position: relative; }
152: ul.domTree li li { list-style: none; }
153: ul.domTree li:first-child::before { position: absolute; top: 0; height: 0.6em; left: -0.75em; width: 0.5em; border-style: none none solid solid; content: ''; border-width: 0.1em; }
154: ul.domTree li:not(:last-child)::after { position: absolute; top: 0; bottom: -0.6em; left: -0.75em; width: 0.5em; border-style: none none solid solid; content: ''; border-width: 0.1em; }
155: ul.domTree span { font-style: italic; font-family: serif; }
156: ul.domTree .t1 code { color: purple; font-weight: bold; }
157: ul.domTree .t2 { font-style: normal; font-family: monospace; }
158: ul.domTree .t2 .name { color: black; font-weight: bold; }
159: ul.domTree .t2 .value { color: blue; font-weight: normal; }
160: ul.domTree .t3 code, .domTree .t4 code, .domTree .t5 code { color: gray; }
161: ul.domTree .t7 code, .domTree .t8 code { color: green; }
162: ul.domTree .t10 code { color: teal; }
163:
164: body.dfnEnabled dfn { cursor: pointer; }
165: .dfnPanel {
166: display: inline;
167: position: absolute;
168: z-index: 10;
169: height: auto;
170: width: auto;
171: padding: 0.5em 0.75em;
172: font: small sans-serif, Droid Sans Fallback;
173: background: #DDDDDD;
174: color: black;
175: border: outset 0.2em;
176: }
177: .dfnPanel * { margin: 0; padding: 0; font: inherit; text-indent: 0; }
178: .dfnPanel :link, .dfnPanel :visited { color: black; }
179: .dfnPanel p { font-weight: bolder; }
180: .dfnPanel * + p { margin-top: 0.25em; }
181: .dfnPanel li { list-style-position: inside; }
182:
183: #configUI { position: absolute; z-index: 20; top: 10em; right: 1em; width: 11em; font-size: small; }
184: #configUI p { margin: 0.5em 0; padding: 0.3em; background: #EEEEEE; color: black; border: inset thin; }
185: #configUI p label { display: block; }
186: #configUI #updateUI, #configUI .loginUI { text-align: center; }
187: #configUI input[type=button] { display: block; margin: auto; }
188:
189: fieldset { margin: 1em; padding: 0.5em 1em; }
190: fieldset > legend + * { margin-top: 0; }
191: fieldset > :last-child { margin-bottom: 0; }
192: fieldset p { margin: 0.5em 0; }
193:
194: </style><link href="style.css" rel="stylesheet"><link href="http://www.w3.org/StyleSheets/TR/W3C-ED" rel="stylesheet" type="text/css"><script src="link-fixup.js" type="text/javascript"></script><style type="text/css">
195:
196: .applies thead th > * { display: block; }
197: .applies thead code { display: block; }
198: .applies tbody th { whitespace: nowrap; }
199: .applies td { text-align: center; }
200: .applies .yes { background: yellow; }
201:
202: .matrix, .matrix td { border: hidden; text-align: right; }
203: .matrix { margin-left: 2em; }
204:
205: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
206: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
207: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
208:
209: td.eg { border-width: thin; text-align: center; }
210:
211: #table-example-1 { border: solid thin; border-collapse: collapse; margin-left: 3em; }
212: #table-example-1 * { font-family: "Essays1743", serif; line-height: 1.01em; }
213: #table-example-1 caption { padding-bottom: 0.5em; }
214: #table-example-1 thead, #table-example-1 tbody { border: none; }
215: #table-example-1 th, #table-example-1 td { border: solid thin; }
216: #table-example-1 th { font-weight: normal; }
217: #table-example-1 td { border-style: none solid; vertical-align: top; }
218: #table-example-1 th { padding: 0.5em; vertical-align: middle; text-align: center; }
219: #table-example-1 tbody tr:first-child td { padding-top: 0.5em; }
220: #table-example-1 tbody tr:last-child td { padding-bottom: 1.5em; }
221: #table-example-1 tbody td:first-child { padding-left: 2.5em; padding-right: 0; width: 9em; }
222: #table-example-1 tbody td:first-child::after { content: leader(". "); }
223: #table-example-1 tbody td { padding-left: 2em; padding-right: 2em; }
224: #table-example-1 tbody td:first-child + td { width: 10em; }
225: #table-example-1 tbody td:first-child + td ~ td { width: 2.5em; }
226: #table-example-1 tbody td:first-child + td + td + td ~ td { width: 1.25em; }
227:
228: .apple-table-examples { border: none; border-collapse: separate; border-spacing: 1.5em 0em; width: 40em; margin-left: 3em; }
229: .apple-table-examples * { font-family: "Times", serif; }
230: .apple-table-examples td, .apple-table-examples th { border: none; white-space: nowrap; padding-top: 0; padding-bottom: 0; }
231: .apple-table-examples tbody th:first-child { border-left: none; width: 100%; }
232: .apple-table-examples thead th:first-child ~ th { font-size: smaller; font-weight: bolder; border-bottom: solid 2px; text-align: center; }
233: .apple-table-examples tbody th::after, .apple-table-examples tfoot th::after { content: leader(". ") }
234: .apple-table-examples tbody th, .apple-table-examples tfoot th { font: inherit; text-align: left; }
235: .apple-table-examples td { text-align: right; vertical-align: top; }
236: .apple-table-examples.e1 tbody tr:last-child td { border-bottom: solid 1px; }
237: .apple-table-examples.e1 tbody + tbody tr:last-child td { border-bottom: double 3px; }
238: .apple-table-examples.e2 th[scope=row] { padding-left: 1em; }
239: .apple-table-examples sup { line-height: 0; }
240:
241: .details-example img { vertical-align: top; }
242:
243: #base64-table {
244: white-space: nowrap;
245: font-size: 0.6em;
246: column-width: 6em;
247: column-count: 5;
248: column-gap: 1em;
249: -moz-column-width: 6em;
250: -moz-column-count: 5;
251: -moz-column-gap: 1em;
252: -webkit-column-width: 6em;
253: -webkit-column-count: 5;
254: -webkit-column-gap: 1em;
255: }
256: #base64-table thead { display: none; }
257: #base64-table * { border: none; }
258: #base64-table tbody td:first-child:after { content: ':'; }
259: #base64-table tbody td:last-child { text-align: right; }
260:
261: #named-character-references-table {
262: white-space: nowrap;
263: font-size: 0.6em;
264: column-width: 30em;
265: column-gap: 1em;
266: -moz-column-width: 30em;
267: -moz-column-gap: 1em;
268: -webkit-column-width: 30em;
269: -webkit-column-gap: 1em;
270: }
271: #named-character-references-table > table > tbody > tr > td:first-child + td,
272: #named-character-references-table > table > tbody > tr > td:last-child { text-align: center; }
273: #named-character-references-table > table > tbody > tr > td:last-child:hover > span { position: absolute; top: auto; left: auto; margin-left: 0.5em; line-height: 1.2; font-size: 5em; border: outset; padding: 0.25em 0.5em; background: white; width: 1.25em; height: auto; text-align: center; }
274: #named-character-references-table > table > tbody > tr#entity-CounterClockwiseContourIntegral > td:first-child { font-size: 0.5em; }
275:
276: .glyph.control { color: red; }
277:
278: @font-face {
279: font-family: 'Essays1743';
280: src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743.ttf');
281: }
282: @font-face {
283: font-family: 'Essays1743';
284: font-weight: bold;
285: src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743-Bold.ttf');
286: }
287: @font-face {
288: font-family: 'Essays1743';
289: font-style: italic;
290: src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743-Italic.ttf');
291: }
292: @font-face {
293: font-family: 'Essays1743';
294: font-style: italic;
295: font-weight: bold;
296: src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743-BoldItalic.ttf');
297: }
298:
299: </style><script type="text/javascript">
300: function getCookie(name) {
301: var params = location.search.substr(1).split("&");
302: for (var index = 0; index < params.length; index++) {
303: if (params[index] == name)
304: return "1";
305: var data = params[index].split("=");
306: if (data[0] == name)
307: return unescape(data[1]);
308: }
309: var cookies = document.cookie.split("; ");
310: for (var index = 0; index < cookies.length; index++) {
311: var data = cookies[index].split("=");
312: if (data[0] == name)
313: return unescape(data[1]);
314: }
315: return null;
316: }
317: function load(script) {
318: var e = document.createElement('script');
319: e.setAttribute('src', script + '?' + encodeURIComponent(location) + '&' + encodeURIComponent(document.referrer));
320: document.body.appendChild(e);
321: }
322: function init() {
323: if (location.search == '?slow-browser')
324: return;
325: var configUI = document.createElement('div');
326: configUI.id = 'configUI';
327: document.body.appendChild(configUI);
328: if (document.getElementById('head'))
329: load('toc.js');
330: load('dfn.js');
331: if (getCookie('profile') == '1')
332: document.getElementsByTagName('h2')[0].textContent += '; load: ' + (new Date() - loadTimer) + 'ms';
333: fixBrokenLink();
334: }
335: </script><script src="dfn.js" type="text/javascript"></script><script src="toc.js" type="text/javascript"></script><link href="dnd.html" rel="prev" title="7.7 Drag and drop">
336: <link href="Overview.html#contents" rel="contents" title="Table of contents">
337: <link href="syntax.html" rel="next" title="8 The HTML syntax">
338: <body class="split chapter"><div class="head" id="head">
339: <div aria-haspopup="true" id="jumpIndexA-button" role="button" tabindex="0">jump
340: <div id="jumpIndexA"><ul><li><a class="noindex" href="the-a-element.html#the-a-element">a</a><a class="noindex" href="the-abbr-element.html#the-abbr-element">abbr</a><a class="noindex" href="the-address-element.html#the-address-element">address</a><a class="noindex" href="the-area-element.html#the-area-element">area</a><a class="noindex" href="the-article-element.html#the-article-element">article</a><a class="noindex" href="the-aside-element.html#the-aside-element">aside</a><a class="noindex" href="the-audio-element.html#the-audio-element">audio</a></ul><ul><li><a class="noindex" href="the-b-element.html#the-b-element">b</a><a class="noindex" href="the-base-element.html#the-base-element">base</a><a class="noindex" href="the-bdi-element.html#the-bdi-element">bdi</a><a class="noindex" href="the-bdo-element.html#the-bdo-element">bdo</a><a class="noindex" href="the-blockquote-element.html#the-blockquote-element">blockquote</a><a class="noindex" href="the-body-element.html#the-body-element">body</a><a class="noindex" href="the-br-element.html#the-br-element">br</a><a class="noindex" href="the-button-element.html#the-button-element">button</a></ul><ul><li><a class="noindex" href="the-canvas-element.html#the-canvas-element">canvas</a><a class="noindex" href="the-caption-element.html#the-caption-element">caption</a><a class="noindex" href="the-cite-element.html#the-cite-element">cite</a><a class="noindex" href="the-code-element.html#the-code-element">code</a><a class="noindex" href="the-col-element.html#the-col-element">col</a><a class="noindex" href="the-colgroup-element.html#the-colgroup-element">colgroup</a><a class="noindex" href="the-command-element.html#the-command-element">command</a></ul><ul><li><a class="noindex" href="the-datalist-element.html#the-datalist-element">datalist</a><a class="noindex" href="the-dd-element.html#the-dd-element">dd</a><a class="noindex" href="the-del-element.html#the-del-element">del</a><a class="noindex" href="the-details-element.html#the-details-element">details</a><a class="noindex" href="the-dfn-element.html#the-dfn-element">dfn</a><a class="noindex" href="the-div-element.html#the-div-element">div</a><a class="noindex" href="the-dl-element.html#the-dl-element">dl</a><a class="noindex" href="the-dt-element.html#the-dt-element">dt</a></ul><ul><li><a class="noindex" href="the-em-element.html#the-em-element">em</a><a class="noindex" href="the-embed-element.html#the-embed-element">embed</a><a class="noindex" href="the-fieldset-element.html#the-fieldset-element">fieldset</a><a class="noindex" href="the-figcaption-element.html#the-figcaption-element">figcaption</a><a class="noindex" href="the-figure-element.html#the-figure-element">figure</a><a class="noindex" href="the-footer-element.html#the-footer-element">footer</a><a class="noindex" href="the-form-element.html#the-form-element">form</a></ul><ul><li><a class="noindex" href="the-h1-h2-h3-h4-h5-and-h6-elements.html#the-h1-h2-h3-h4-h5-and-h6-elements">h1</a><a class="noindex" href="the-h1-h2-h3-h4-h5-and-h6-elements.html#the-h1-h2-h3-h4-h5-and-h6-elements">h2</a><a class="noindex" href="the-h1-h2-h3-h4-h5-and-h6-elements.html#the-h1-h2-h3-h4-h5-and-h6-elements">h3</a><a class="noindex" href="the-h1-h2-h3-h4-h5-and-h6-elements.html#the-h1-h2-h3-h4-h5-and-h6-elements">h4</a><a class="noindex" href="the-h1-h2-h3-h4-h5-and-h6-elements.html#the-h1-h2-h3-h4-h5-and-h6-elements">h5</a><a class="noindex" href="the-h1-h2-h3-h4-h5-and-h6-elements.html#the-h1-h2-h3-h4-h5-and-h6-elements">h6</a><a class="noindex" href="the-head-element.html#the-head-element">head</a><a class="noindex" href="the-header-element.html#the-header-element">header</a><a class="noindex" href="the-hgroup-element.html#the-hgroup-element">hgroup</a><a class="noindex" href="the-hr-element.html#the-hr-element">hr</a><a class="noindex" href="the-html-element.html#the-html-element">html</a></ul><ul><li><a class="noindex" href="the-i-element.html#the-i-element">i</a><a class="noindex" href="the-iframe-element.html#the-iframe-element">iframe</a><a class="noindex" href="the-img-element.html#the-img-element">img</a><a class="noindex" href="the-input-element.html#the-input-element">input</a><a class="noindex" href="the-ins-element.html#the-ins-element">ins</a><a class="noindex" href="the-kbd-element.html#the-kbd-element">kbd</a><a class="noindex" href="the-keygen-element.html#the-keygen-element">keygen</a></ul><ul><li><a class="noindex" href="the-label-element.html#the-label-element">label</a><a class="noindex" href="the-legend-element.html#the-legend-element">legend</a><a class="noindex" href="the-li-element.html#the-li-element">li</a><a class="noindex" href="the-link-element.html#the-link-element">link</a><a class="noindex" href="the-map-element.html#the-map-element">map</a><a class="noindex" href="the-mark-element.html#the-mark-element">mark</a><a class="noindex" href="the-menu-element.html#the-menu-element">menu</a><a class="noindex" href="the-meta-element.html#the-meta-element">meta</a><a class="noindex" href="the-meter-element.html#the-meter-element">meter</a></ul><ul><li><a class="noindex" href="the-nav-element.html#the-nav-element">nav</a><a class="noindex" href="the-noscript-element.html#the-noscript-element">noscript</a><a class="noindex" href="the-object-element.html#the-object-element">object</a><a class="noindex" href="the-ol-element.html#the-ol-element">ol</a><a class="noindex" href="the-optgroup-element.html#the-optgroup-element">optgroup</a><a class="noindex" href="the-option-element.html#the-option-element">option</a><a class="noindex" href="the-output-element.html#the-output-element">output</a></ul><ul><li><a class="noindex" href="the-p-element.html#the-p-element">p</a><a class="noindex" href="the-param-element.html#the-param-element">param</a><a class="noindex" href="the-pre-element.html#the-pre-element">pre</a><a class="noindex" href="the-progress-element.html#the-progress-element">progress</a><a class="noindex" href="the-q-element.html#the-q-element">q</a><a class="noindex" href="the-rp-element.html#the-rp-element">rp</a><a class="noindex" href="the-rt-element.html#the-rt-element">rt</a><a class="noindex" href="the-ruby-element.html#the-ruby-element">ruby</a></ul><ul><li><a class="noindex" href="the-s-element.html#the-s-element">s</a><a class="noindex" href="the-samp-element.html#the-samp-element">samp</a><a class="noindex" href="the-script-element.html#the-script-element">script</a><a class="noindex" href="the-section-element.html#the-section-element">section</a><a class="noindex" href="the-select-element.html#the-select-element">select</a><a class="noindex" href="the-small-element.html#the-small-element">small</a><a class="noindex" href="the-source-element.html#the-source-element">source</a><a class="noindex" href="the-span-element.html#the-span-element">span</a></ul><ul><li><a class="noindex" href="the-strong-element.html#the-strong-element">strong</a><a class="noindex" href="the-style-element.html#the-style-element">style</a><a class="noindex" href="the-sub-and-sup-elements.html#the-sub-and-sup-elements">sub</a><a class="noindex" href="the-summary-element.html#the-summary-element">summary</a><a class="noindex" href="the-sub-and-sup-elements.html#the-sub-and-sup-elements">sup</a></ul><ul><li><a class="noindex" href="the-table-element.html#the-table-element">table</a><a class="noindex" href="the-tbody-element.html#the-tbody-element">tbody</a><a class="noindex" href="the-td-element.html#the-td-element">td</a><a class="noindex" href="the-textarea-element.html#the-textarea-element">textarea</a><a class="noindex" href="the-tfoot-element.html#the-tfoot-element">tfoot</a><a class="noindex" href="the-th-element.html#the-th-element">th</a><a class="noindex" href="the-thead-element.html#the-thead-element">thead</a><a class="noindex" href="the-time-element.html#the-time-element">time</a><a class="noindex" href="the-title-element.html#the-title-element">title</a></ul><ul><li><a class="noindex" href="the-tr-element.html#the-tr-element">tr</a><a class="noindex" href="the-track-element.html#the-track-element">track</a><a class="noindex" href="the-u-element.html#the-u-element">u</a><a class="noindex" href="the-ul-element.html#the-ul-element">ul</a><a class="noindex" href="the-var-element.html#the-var-element">var</a><a class="noindex" href="the-video-element.html#the-video-element">video</a><a class="noindex" href="the-wbr-element.html#the-wbr-element">wbr</a></ul><ul class="jumpIndexA-other"><li><a class="noindex" href="global-attributes.html#global-attributes">global attributes</a><a class="noindex" href="index-of-terms.html#index-of-terms">terms</a></ul></div></div>
341: <script src="jump-indexes.js"></script><p><a href="http://www.w3.org/"><img alt="W3C" height="48" src="http://www.w3.org/Icons/w3c_home" width="72"></a></p>
342:
343: <h1>HTML5: Edition for Web Authors</h1>
344:
345: </div><div class="prev_next">
346: <a href="dnd.html">← 7.7 Drag and drop</a> –
347: <a href="Overview.html#contents">Table of contents</a> –
348: <a href="syntax.html">8 The HTML syntax →</a>
349: </div>
350:
351: <h3 id="editing-apis"><span class="secno">7.8 </span>Editing APIs</h3><dl class="domintro"><dt><var title="">document</var> . <code id="dom-document-execcommand" title="dom-document-execCommand"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/dnd.html#execCommand" title='Read about this "execCommand" reference in the full HTML5 spec.'>execCommand</a></code>(<var title="">commandId</var> [, <var title="">showUI</var> [, <var title="">value</var> ] ] )</dt>
352:
353: <dd>
354:
355: <p>Runs the action specified by the first argument, as described
356: in the list below. The second and third arguments sometimes affect
357: the action. (If they don't they are ignored.)</p>
358:
359: </dd>
360:
361: <dt><var title="">document</var> . <code id="dom-document-querycommandenabled" title="dom-document-queryCommandEnabled"><a href="#dom-document-querycommandenabled">queryCommandEnabled</a></code>(<var title="">commandId</var>)</dt>
362:
363: <dd>
364:
365: <p>Returns whether the given command is enabled, as described in the list below.</p>
366:
367: </dd>
368:
369: <dt><var title="">document</var> . <code id="dom-document-querycommandindeterm" title="dom-document-queryCommandIndeterm"><a href="#dom-document-querycommandindeterm">queryCommandIndeterm</a></code>(<var title="">commandId</var>)</dt>
370:
371: <dd>
372:
373: <p>Returns whether the given command is indeterminate, as described in the list below.</p>
374:
375: </dd>
376:
377: <dt><var title="">document</var> . <code id="dom-document-querycommandstate" title="dom-document-queryCommandState"><a href="#dom-document-querycommandstate">queryCommandState</a></code>(<var title="">commandId</var>)</dt>
378:
379: <dd>
380:
381: <p>Returns the state of the command, as described in the list below.</p>
382:
383: </dd>
384:
385: <dt><var title="">document</var> . <code id="dom-document-querycommandsupported" title="dom-document-queryCommandSupported"><a href="#dom-document-querycommandsupported">queryCommandSupported</a></code>(<var title="">commandId</var>)</dt>
386:
387: <dd>
388:
389: <p>Returns true if the command is supported; otherwise, returns false.</p>
390:
391: </dd>
392:
393: <dt><var title="">document</var> . <code id="dom-document-querycommandvalue" title="dom-document-queryCommandValue"><a href="#dom-document-querycommandvalue">queryCommandValue</a></code>(<var title="">commandId</var>)</dt>
394:
395: <dd>
396:
397: <p>Returns the value of the command, as described in the list below.</p>
398:
399: </dd>
400:
401: </dl><p>A document is <dfn aria-haspopup="true" id="ready-for-editing-host-commands" role="button" tabindex="0">ready for editing host commands</dfn> if it
402: has a selection that is entirely within an <a class="full-spec-link" href="http://dev.w3.org/html5/spec/editing.html#editing-host" title='Read about this "editing host" reference in the full HTML5 spec.'>editing
403: host</a>, or if it has no selection but its caret is inside an
404: <a class="full-spec-link" href="http://dev.w3.org/html5/spec/editing.html#editing-host" title='Read about this "editing host" reference in the full HTML5 spec.'>editing host</a>.<p>The possible values for <var title="">commandId</var>, and their
405: corresponding meanings, are as follows. <dl><dt><dfn aria-haspopup="true" id="command-bold" role="button" tabindex="0"><code>bold</code></dfn></dt>
406: <dd><strong>Summary</strong>: Toggles whether the selection is bold.</dd>
407:
408: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_0">ready for
409: editing host commands</a>.</dd>
410: <dd><strong>Indeterminate When</strong>: Never.</dd>
411: <dd><strong>State</strong>: True if the selection, or the caret, if
412: there is no selection, is, or is contained within, a
413: <code><a href="the-b-element.html#the-b-element" id="b_17">b</a></code> element. False otherwise.</dd>
414: <dd><strong>Value</strong>: The string "<code title="">true</code>"
415: if the expression given for the "State" above is true, the string
416: "<code title="">false</code>" otherwise.</dd>
417:
418: <dt><dfn aria-haspopup="true" id="command-createlink" role="button" tabindex="0"><code>createLink</code></dfn></dt>
419: <dd><strong>Summary</strong>: Toggles whether the selection is a
420: link or not. If the second argument is true, and a link is to be
421: added, the user agent will ask the user for the address. Otherwise,
422: the third argument will be used as the address.</dd>
423:
424: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_1">ready for
425: editing host commands</a>.</dd>
426: <dd><strong>Indeterminate When</strong>: Never.</dd>
427: <dd><strong>State</strong>: Always false.</dd>
428: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
429:
430: <dt><dfn aria-haspopup="true" id="command-delete" role="button" tabindex="0"><code>delete</code></dfn></dt>
431: <dd><strong>Summary</strong>: Deletes the selection or the
432: character before the cursor.</dd>
433:
434: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_2">ready for
435: editing host commands</a>.</dd>
436: <dd><strong>Indeterminate When</strong>: Never.</dd>
437: <dd><strong>State</strong>: Always false.</dd>
438: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
439:
440: <dt><dfn aria-haspopup="true" id="command-formatblock" role="button" tabindex="0"><code>formatBlock</code></dfn></dt>
441: <dd><strong>Summary</strong>: Wraps the selection in the element
442: given by the third argument. If the third argument doesn't
443: specify an element that is a <dfn aria-haspopup="true" id="formatblock-candidate" role="button" tabindex="0"><code title="">formatBlock</code>
444: candidate</dfn>, does nothing.</dd>
445:
446: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_3">ready for
447: editing host commands</a>.</dd>
448: <dd><strong>Indeterminate When</strong>: Never.</dd>
449: <dd><strong>State</strong>: Always false.</dd>
450: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
451:
452: <dt><dfn aria-haspopup="true" id="command-forwarddelete" role="button" tabindex="0"><code>forwardDelete</code></dfn></dt>
453: <dd><strong>Summary</strong>: Deletes the selection or the
454: character after the cursor.</dd>
455:
456: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_4">ready for
457: editing host commands</a>.</dd>
458: <dd><strong>Indeterminate When</strong>: Never.</dd>
459: <dd><strong>State</strong>: Always false.</dd>
460: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
461:
462: <dt><dfn aria-haspopup="true" id="command-insertimage" role="button" tabindex="0"><code>insertImage</code></dfn></dt>
463: <dd><strong>Summary</strong>: Toggles whether the selection is an
464: image or not. If the second argument is true, and an image is to be
465: added, the user agent will ask the user for the address. Otherwise,
466: the third argument will be used as the address.</dd>
467:
468: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_5">ready for
469: editing host commands</a>.</dd>
470: <dd><strong>Indeterminate When</strong>: Never.</dd>
471: <dd><strong>State</strong>: Always false.</dd>
472: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
473:
474: <dt><dfn aria-haspopup="true" id="command-inserthtml" role="button" tabindex="0"><code>insertHTML</code></dfn></dt>
475: <dd><strong>Summary</strong>: Replaces the selection with the value
476: of the third argument parsed as HTML.</dd>
477:
478: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_6">ready for
479: editing host commands</a>.</dd>
480: <dd><strong>Indeterminate When</strong>: Never.</dd>
481: <dd><strong>State</strong>: Always false.</dd>
482: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
483:
484: <dt><dfn aria-haspopup="true" id="command-insertlinebreak" role="button" tabindex="0"><code>insertLineBreak</code></dfn></dt>
485: <dd><strong>Summary</strong>: Inserts a line break.</dd>
486:
487: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_7">ready for
488: editing host commands</a>.</dd>
489: <dd><strong>Indeterminate When</strong>: Never.</dd>
490: <dd><strong>State</strong>: Always false.</dd>
491: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
492:
493: <dt><dfn aria-haspopup="true" id="command-insertorderedlist" role="button" tabindex="0"><code>insertOrderedList</code></dfn></dt>
494: <dd><strong>Summary</strong>: Toggles whether the selection is an ordered list.</dd>
495:
496: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_8">ready for
497: editing host commands</a>.</dd>
498: <dd><strong>Indeterminate When</strong>: Never.</dd>
499: <dd><strong>State</strong>: Always false.</dd>
500: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
501:
502: <dt><dfn aria-haspopup="true" id="command-insertunorderedlist" role="button" tabindex="0"><code>insertUnorderedList</code></dfn></dt>
503: <dd><strong>Summary</strong>: Toggles whether the selection is an unordered list.</dd>
504:
505: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_9">ready for
506: editing host commands</a>.</dd>
507: <dd><strong>Indeterminate When</strong>: Never.</dd>
508: <dd><strong>State</strong>: Always false.</dd>
509: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
510:
511: <dt><dfn aria-haspopup="true" id="command-insertparagraph" role="button" tabindex="0"><code>insertParagraph</code></dfn></dt>
512: <dd><strong>Summary</strong>: Inserts a paragraph break.</dd>
513:
514: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_10">ready for
515: editing host commands</a>.</dd>
516: <dd><strong>Indeterminate When</strong>: Never.</dd>
517: <dd><strong>State</strong>: Always false.</dd>
518: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
519:
520: <dt><dfn aria-haspopup="true" id="command-inserttext" role="button" tabindex="0"><code>insertText</code></dfn></dt>
521: <dd><strong>Summary</strong>: Inserts the text given in the third parameter.</dd>
522:
523: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_11">ready for
524: editing host commands</a>.</dd>
525: <dd><strong>Indeterminate When</strong>: Never.</dd>
526: <dd><strong>State</strong>: Always false.</dd>
527: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
528:
529: <dt><dfn aria-haspopup="true" id="command-italic" role="button" tabindex="0"><code>italic</code></dfn></dt>
530: <dd><strong>Summary</strong>: Toggles whether the selection is italic.</dd>
531:
532: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_12">ready for
533: editing host commands</a>.</dd>
534: <dd><strong>Indeterminate When</strong>: Never.</dd>
535: <dd><strong>State</strong>: True if the selection, or the caret, if
536: there is no selection, is, or is contained within, a
537: <code><a href="the-i-element.html#the-i-element" id="i_26">i</a></code> element. False otherwise.</dd>
538: <dd><strong>Value</strong>: The string "<code title="">true</code>"
539: if the expression given for the "State" above is true, the string
540: "<code title="">false</code>" otherwise.</dd>
541:
542: <dt><dfn aria-haspopup="true" id="command-redo" role="button" tabindex="0"><code>redo</code></dfn></dt>
543: <dd><strong>Summary</strong>: Acts as if the user had requested a redo.</dd>
544:
545: <dd><strong>Enabled When</strong>: The <span>undo position</span>
546: is not at the end of the <span>undo transaction
547: history</span>.</dd>
548: <dd><strong>Indeterminate When</strong>: Never.</dd>
549: <dd><strong>State</strong>: Always false.</dd>
550: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
551:
552: <dt><dfn aria-haspopup="true" id="command-selectall" role="button" tabindex="0"><code>selectAll</code></dfn></dt>
553: <dd><strong>Summary</strong>: Selects all the editable content.</dd>
554:
555: <dd><strong>Enabled When</strong>: Always.</dd>
556: <dd><strong>Indeterminate When</strong>: Never.</dd>
557: <dd><strong>State</strong>: Always false.</dd>
558: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
559:
560: <dt><dfn aria-haspopup="true" id="command-subscript" role="button" tabindex="0"><code>subscript</code></dfn></dt>
561: <dd><strong>Summary</strong>: Toggles whether the selection is subscripted.</dd>
562:
563: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_13">ready for
564: editing host commands</a>.</dd>
565: <dd><strong>Indeterminate When</strong>: Never.</dd>
566: <dd><strong>State</strong>: True if the selection, or the caret, if
567: there is no selection, is, or is contained within, a
568: <code><a href="the-sub-and-sup-elements.html#the-sub-and-sup-elements" id="sub_7">sub</a></code> element. False otherwise.</dd>
569: <dd><strong>Value</strong>: The string "<code title="">true</code>"
570: if the expression given for the "State" above is true, the string
571: "<code title="">false</code>" otherwise.</dd>
572:
573: <dt><dfn aria-haspopup="true" id="command-superscript" role="button" tabindex="0"><code>superscript</code></dfn></dt>
574: <dd><strong>Summary</strong>: Toggles whether the selection is superscripted.</dd>
575:
576: <dd><strong>Enabled When</strong>: The document is <a href="#ready-for-editing-host-commands" id="ready-for-editing-host-commands_14">ready for
577: editing host commands</a>.</dd>
578: <dd><strong>Indeterminate When</strong>: Never.</dd>
579: <dd><strong>State</strong>: True if the selection, or the caret, if
580: there is no selection, is, or is contained within, a
581: <code><a href="the-sub-and-sup-elements.html#the-sub-and-sup-elements" id="sup_5">sup</a></code> element. False otherwise.</dd>
582: <dd><strong>Value</strong>: The string "<code title="">true</code>"
583: if the expression given for the "State" above is true, the string
584: "<code title="">false</code>" otherwise.</dd>
585:
586: <dt><dfn aria-haspopup="true" id="command-undo" role="button" tabindex="0"><code>undo</code></dfn></dt>
587: <dd><strong>Summary</strong>: Acts as if the user had requested an undo.</dd>
588:
589: <dd><strong>Enabled When</strong>: The <span>undo position</span>
590: is not at the start of the <span>undo transaction
591: history</span>.</dd>
592: <dd><strong>Indeterminate When</strong>: Never.</dd>
593: <dd><strong>State</strong>: Always false.</dd>
594: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
595:
596: <dt><dfn aria-haspopup="true" id="command-unlink" role="button" tabindex="0"><code>unlink</code></dfn></dt>
597: <dd><strong>Summary</strong>: Removes all links from the selection.</dd>
598:
599: <dd><strong>Enabled When</strong>: The document has a selection
600: that is entirely within an <a class="full-spec-link" href="http://dev.w3.org/html5/spec/editing.html#editing-host" title='Read about this "editing host" reference in the full HTML5 spec.'>editing host</a> and that
601: contains (either partially or completely) at least one
1.5 ! mike 602: <code><a href="the-a-element.html#the-a-element" id="a_59">a</a></code> element that has an <code title="attr-hyperlink-href"><a href="links.html#attr-hyperlink-href" id="href_31">href</a></code> attribute.</dd>
1.1 mike 603: <dd><strong>Indeterminate When</strong>: Never.</dd>
604: <dd><strong>State</strong>: Always false.</dd>
605: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
606:
607: <dt><dfn aria-haspopup="true" id="command-unselect" role="button" tabindex="0"><code>unselect</code></dfn></dt>
608: <dd><strong>Summary</strong>: Unselects everything.</dd>
609:
610: <dd><strong>Enabled When</strong>: Always.</dd>
611: <dd><strong>Indeterminate When</strong>: Never.</dd>
612: <dd><strong>State</strong>: Always false.</dd>
613: <dd><strong>Value</strong>: Always the string "<code title="">false</code>".</dd>
614:
615:
616:
617:
618:
619:
620:
621:
622:
623:
624:
625:
626:
627:
628:
629: </dl>
Webmaster
![[BACK]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/back.gif?vpn-1){kind=icon}
Return to editing-apis.html CVS log ![[TXT]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/text.gif?vpn-1){kind=icon}
![[DIR]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/dir.gif?vpn-1){kind=icon}
Up to [Public] / html5 / spec-author-view