Annotation of html5/spec-author-view/the-button-element.html, revision 1.236
1.187 mike 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"><!-- when publishing, change bits marked ZZZ --><html class="split chapter" lang="en-US-x-Hixie"><meta content="text/html; charset=ascii" http-equiv="Content-Type"><title>4.10.8 The button element — HTML5 (Edition for Web Authors)</title><link href="whatwg.css" rel="stylesheet"><style type="text/css">
1.1 mike 2: pre { margin-left: 2em; white-space: pre-wrap; }
3: h2 { margin: 3em 0 1em 0; }
4: h3 { margin: 2.5em 0 1em 0; }
5: h4 { margin: 2.5em 0 0.75em 0; }
6: h5, h6 { margin: 2.5em 0 1em; }
7: h1 + h2, h1 + h2 + h2 { margin: 0.75em 0 0.75em; }
8: h2 + h3, h3 + h4, h4 + h5, h5 + h6 { margin-top: 0.5em; }
9: p { margin: 1em 0; }
10: hr:not(.top) { display: block; background: none; border: none; padding: 0; margin: 2em 0; height: auto; }
11: dl, dd { margin-top: 0; margin-bottom: 0; }
12: dt { margin-top: 0.75em; margin-bottom: 0.25em; clear: left; }
13: dt + dt { margin-top: 0; }
14: dd dt { margin-top: 0.25em; margin-bottom: 0; }
15: dd p { margin-top: 0; }
16: dd dl + p { margin-top: 1em; }
17: dd table + p { margin-top: 1em; }
18: p + * > li, dd li { margin: 1em 0; }
19: dt, dfn { font-weight: bold; font-style: normal; }
20: dt dfn { font-style: italic; }
21: pre, code { font-size: inherit; font-family: monospace; font-variant: normal; }
22: pre strong { color: black; font: inherit; font-weight: bold; background: yellow; }
23: pre em { font-weight: bolder; font-style: normal; }
24: @media screen { code { color: orangered; } code :link, code :visited { color: inherit; } }
25: var sub { vertical-align: bottom; font-size: smaller; position: relative; top: 0.1em; }
26: table { border-collapse: collapse; border-style: hidden hidden none hidden; }
1.34 mike 27: table thead, table tbody { border-bottom: solid; }
1.1 mike 28: table tbody th:first-child { border-left: solid; }
29: table tbody th { text-align: left; }
30: table td, table th { border-left: solid; border-right: solid; border-bottom: solid thin; vertical-align: top; padding: 0.2em; }
31: blockquote { margin: 0 0 0 2em; border: 0; padding: 0; font-style: italic; }
32:
33: .bad, .bad *:not(.XXX) { color: gray; border-color: gray; background: transparent; }
34: .matrix, .matrix td { border: none; text-align: right; }
35: .matrix { margin-left: 2em; }
36: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
37: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
38: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
39:
40: .toc dfn, h1 dfn, h2 dfn, h3 dfn, h4 dfn, h5 dfn, h6 dfn { font: inherit; }
41: img.extra { float: right; }
42: pre.idl { border: solid thin; background: #EEEEEE; color: black; padding: 0.5em 1em; }
43: pre.idl :link, pre.idl :visited { color: inherit; background: transparent; }
44: pre.css { border: solid thin; background: #FFFFEE; color: black; padding: 0.5em 1em; }
45: pre.css:first-line { color: #AAAA50; }
1.23 mike 46: dl.domintro { color: green; margin: 2em 0 2em 2em; padding: 0.5em 1em; border: none; background: #DDFFDD; }
1.1 mike 47: hr + dl.domintro, div.impl + dl.domintro { margin-top: 2.5em; margin-bottom: 1.5em; }
48: dl.domintro dt, dl.domintro dt * { color: black; text-decoration: none; }
49: dl.domintro dd { margin: 0.5em 0 1em 2em; padding: 0; }
50: dl.domintro dd p { margin: 0.5em 0; }
51: dl.switch { padding-left: 2em; }
52: dl.switch > dt { text-indent: -1.5em; }
53: dl.switch > dt:before { content: '\21AA'; padding: 0 0.5em 0 0; display: inline-block; width: 1em; text-align: right; line-height: 0.5em; }
54: dl.triple { padding: 0 0 0 1em; }
55: dl.triple dt, dl.triple dd { margin: 0; display: inline }
56: dl.triple dt:after { content: ':'; }
57: dl.triple dd:after { content: '\A'; white-space: pre; }
58: .diff-old { text-decoration: line-through; color: silver; background: transparent; }
59: .diff-chg, .diff-new { text-decoration: underline; color: green; background: transparent; }
60: a .diff-new { border-bottom: 1px blue solid; }
61:
62: h2 { page-break-before: always; }
63: h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
64: h1 + h2, hr + h2.no-toc { page-break-before: auto; }
65:
66: p > span:not([title=""]):not([class="XXX"]):not([class="impl"]), li > span:not([title=""]):not([class="XXX"]):not([class="impl"]) { border-bottom: solid #9999CC; }
67:
68: div.head { margin: 0 0 1em; padding: 1em 0 0 0; }
69: div.head p { margin: 0; }
70: div.head h1 { margin: 0; }
71: div.head .logo { float: right; margin: 0 1em; }
72: div.head .logo img { border: none } /* remove border from top image */
73: div.head dl { margin: 1em 0; }
74: div.head p.copyright, div.head p.alt { font-size: x-small; font-style: oblique; margin: 0; }
75:
76: body > .toc > li { margin-top: 1em; margin-bottom: 1em; }
77: body > .toc.brief > li { margin-top: 0.35em; margin-bottom: 0.35em; }
78: body > .toc > li > * { margin-bottom: 0.5em; }
79: body > .toc > li > * > li > * { margin-bottom: 0.25em; }
80: .toc, .toc li { list-style: none; }
81:
82: .brief { margin-top: 1em; margin-bottom: 1em; line-height: 1.1; }
83: .brief li { margin: 0; padding: 0; }
84: .brief li p { margin: 0; padding: 0; }
85:
86: .category-list { margin-top: -0.75em; margin-bottom: 1em; line-height: 1.5; }
87: .category-list::before { content: '\21D2\A0'; font-size: 1.2em; font-weight: 900; }
88: .category-list li { display: inline; }
89: .category-list li:not(:last-child)::after { content: ', '; }
90: .category-list li > span, .category-list li > a { text-transform: lowercase; }
91: .category-list li * { text-transform: none; } /* don't affect <code> nested in <a> */
92:
93: .XXX { color: #E50000; background: white; border: solid red; padding: 0.5em; margin: 1em 0; }
94: .XXX > :first-child { margin-top: 0; }
95: p .XXX { line-height: 3em; }
96: .annotation { border: solid thin black; background: #0C479D; color: white; position: relative; margin: 8px 0 20px 0; }
97: .annotation:before { position: absolute; left: 0; top: 0; width: 100%; height: 100%; margin: 6px -6px -6px 6px; background: #333333; z-index: -1; content: ''; }
98: .annotation :link, .annotation :visited { color: inherit; }
99: .annotation :link:hover, .annotation :visited:hover { background: transparent; }
100: .annotation span { border: none ! important; }
101: .note { color: green; background: transparent; font-family: sans-serif; }
102: .warning { color: red; background: transparent; }
103: .note, .warning { font-weight: bolder; font-style: italic; }
104: p.note, div.note { padding: 0.5em 2em; }
105: span.note { padding: 0 2em; }
106: .note p:first-child, .warning p:first-child { margin-top: 0; }
107: .note p:last-child, .warning p:last-child { margin-bottom: 0; }
108: .warning:before { font-style: normal; }
109: p.note:before { content: 'Note: '; }
110: p.warning:before { content: '\26A0 Warning! '; }
111:
112: .bookkeeping:before { display: block; content: 'Bookkeeping details'; font-weight: bolder; font-style: italic; }
113: .bookkeeping { font-size: 0.8em; margin: 2em 0; }
114: .bookkeeping p { margin: 0.5em 2em; display: list-item; list-style: square; }
1.132 mike 115: .bookkeeping dt { margin: 0.5em 2em 0; }
116: .bookkeeping dd { margin: 0 3em 0.5em; }
1.1 mike 117:
118: h4 { position: relative; z-index: 3; }
119: h4 + .element, h4 + div + .element { margin-top: -2.5em; padding-top: 2em; }
120: .element {
121: background: #EEEEFF;
122: color: black;
123: margin: 0 0 1em 0.15em;
124: padding: 0 1em 0.25em 0.75em;
125: border-left: solid #9999FF 0.25em;
126: position: relative;
127: z-index: 1;
128: }
129: .element:before {
130: position: absolute;
131: z-index: 2;
132: top: 0;
133: left: -1.15em;
134: height: 2em;
135: width: 0.9em;
136: background: #EEEEFF;
137: content: ' ';
138: border-style: none none solid solid;
139: border-color: #9999FF;
140: border-width: 0.25em;
141: }
142:
143: .example { display: block; color: #222222; background: #FCFCFC; border-left: double; margin-left: 2em; padding-left: 1em; }
144: td > .example:only-child { margin: 0 0 0 0.1em; }
145:
146: ul.domTree, ul.domTree ul { padding: 0 0 0 1em; margin: 0; }
147: ul.domTree li { padding: 0; margin: 0; list-style: none; position: relative; }
148: ul.domTree li li { list-style: none; }
149: 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; }
150: 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; }
151: ul.domTree span { font-style: italic; font-family: serif; }
152: ul.domTree .t1 code { color: purple; font-weight: bold; }
153: ul.domTree .t2 { font-style: normal; font-family: monospace; }
154: ul.domTree .t2 .name { color: black; font-weight: bold; }
155: ul.domTree .t2 .value { color: blue; font-weight: normal; }
156: ul.domTree .t3 code, .domTree .t4 code, .domTree .t5 code { color: gray; }
157: ul.domTree .t7 code, .domTree .t8 code { color: green; }
158: ul.domTree .t10 code { color: teal; }
159:
1.14 mike 160: body.dfnEnabled dfn { cursor: pointer; }
161: .dfnPanel {
162: display: inline;
163: position: absolute;
164: z-index: 10;
165: height: auto;
166: width: auto;
167: padding: 0.5em 0.75em;
168: font: small sans-serif, Droid Sans Fallback;
169: background: #DDDDDD;
170: color: black;
171: border: outset 0.2em;
172: }
173: .dfnPanel * { margin: 0; padding: 0; font: inherit; text-indent: 0; }
174: .dfnPanel :link, .dfnPanel :visited { color: black; }
175: .dfnPanel p { font-weight: bolder; }
176: .dfnPanel * + p { margin-top: 0.25em; }
177: .dfnPanel li { list-style-position: inside; }
178:
1.1 mike 179: #configUI { position: absolute; z-index: 20; top: 10em; right: 1em; width: 11em; font-size: small; }
180: #configUI p { margin: 0.5em 0; padding: 0.3em; background: #EEEEEE; color: black; border: inset thin; }
181: #configUI p label { display: block; }
182: #configUI #updateUI, #configUI .loginUI { text-align: center; }
183: #configUI input[type=button] { display: block; margin: auto; }
1.121 mike 184:
1.1 mike 185: </style><style type="text/css">
186:
187: .applies thead th > * { display: block; }
188: .applies thead code { display: block; }
189: .applies tbody th { whitespace: nowrap; }
190: .applies td { text-align: center; }
191: .applies .yes { background: yellow; }
192:
1.136 mike 193: .matrix, .matrix td { border: hidden; text-align: right; }
1.1 mike 194: .matrix { margin-left: 2em; }
195:
196: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
197: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
198: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
199:
1.213 mike 200: td.eg { border-width: thin; text-align: center; }
201:
1.1 mike 202: #table-example-1 { border: solid thin; border-collapse: collapse; margin-left: 3em; }
203: #table-example-1 * { font-family: "Essays1743", serif; line-height: 1.01em; }
204: #table-example-1 caption { padding-bottom: 0.5em; }
205: #table-example-1 thead, #table-example-1 tbody { border: none; }
206: #table-example-1 th, #table-example-1 td { border: solid thin; }
207: #table-example-1 th { font-weight: normal; }
208: #table-example-1 td { border-style: none solid; vertical-align: top; }
209: #table-example-1 th { padding: 0.5em; vertical-align: middle; text-align: center; }
210: #table-example-1 tbody tr:first-child td { padding-top: 0.5em; }
211: #table-example-1 tbody tr:last-child td { padding-bottom: 1.5em; }
212: #table-example-1 tbody td:first-child { padding-left: 2.5em; padding-right: 0; width: 9em; }
213: #table-example-1 tbody td:first-child::after { content: leader(". "); }
214: #table-example-1 tbody td { padding-left: 2em; padding-right: 2em; }
215: #table-example-1 tbody td:first-child + td { width: 10em; }
216: #table-example-1 tbody td:first-child + td ~ td { width: 2.5em; }
217: #table-example-1 tbody td:first-child + td + td + td ~ td { width: 1.25em; }
218:
219: .apple-table-examples { border: none; border-collapse: separate; border-spacing: 1.5em 0em; width: 40em; margin-left: 3em; }
220: .apple-table-examples * { font-family: "Times", serif; }
221: .apple-table-examples td, .apple-table-examples th { border: none; white-space: nowrap; padding-top: 0; padding-bottom: 0; }
222: .apple-table-examples tbody th:first-child { border-left: none; width: 100%; }
223: .apple-table-examples thead th:first-child ~ th { font-size: smaller; font-weight: bolder; border-bottom: solid 2px; text-align: center; }
224: .apple-table-examples tbody th::after, .apple-table-examples tfoot th::after { content: leader(". ") }
225: .apple-table-examples tbody th, .apple-table-examples tfoot th { font: inherit; text-align: left; }
226: .apple-table-examples td { text-align: right; vertical-align: top; }
227: .apple-table-examples.e1 tbody tr:last-child td { border-bottom: solid 1px; }
1.9 mike 228: .apple-table-examples.e1 tbody + tbody tr:last-child td { border-bottom: double 3px; }
229: .apple-table-examples.e2 th[scope=row] { padding-left: 1em; }
230: .apple-table-examples sup { line-height: 0; }
231:
1.11 mike 232: .details-example img { vertical-align: top; }
233:
1.26 mike 234: #named-character-references-table {
235: font-size: 0.6em;
236: column-width: 28em;
237: column-gap: 1em;
238: -moz-column-width: 28em;
239: -moz-column-gap: 1em;
240: -webkit-column-width: 28em;
241: -webkit-column-gap: 1em;
242: }
243: #named-character-references-table > table > tbody > tr > td:last-child { text-align: center; }
244: #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; }
245:
1.35 mike 246: .glyph.control { color: red; }
247:
1.38 mike 248: @font-face {
249: font-family: 'Essays1743';
250: src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743.ttf');
251: }
252: @font-face {
253: font-family: 'Essays1743';
254: font-weight: bold;
255: src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743-Bold.ttf');
256: }
257: @font-face {
258: font-family: 'Essays1743';
259: font-style: italic;
260: src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743-Italic.ttf');
261: }
262: @font-face {
263: font-family: 'Essays1743';
264: font-style: italic;
265: font-weight: bold;
266: src: url('http://www.whatwg.org/specs/web-apps/current-work/fonts/Essays1743-BoldItalic.ttf');
267: }
268:
1.25 mike 269: </style><link href="data:text/css," id="complete" rel="stylesheet" title="Complete specification"><link href="data:text/css,.impl%20%7B%20display:%20none;%20%7D%0Ahtml%20%7B%20border:%20solid%20yellow;%20%7D%20.domintro:before%20%7B%20display:%20none;%20%7D" id="author" rel="alternate stylesheet" title="Author documentation only"><link href="data:text/css,.impl%20%7B%20background:%20%23FFEEEE;%20%7D%20.domintro:before%20%7B%20background:%20%23FFEEEE;%20%7D" id="highlight" rel="alternate stylesheet" title="Highlight implementation requirements"><script type="text/javascript">
1.157 mike 270: function getCookie(name) {
271: var params = location.search.substr(1).split("&");
272: for (var index = 0; index < params.length; index++) {
273: if (params[index] == name)
274: return "1";
275: var data = params[index].split("=");
276: if (data[0] == name)
277: return unescape(data[1]);
1.9 mike 278: }
1.157 mike 279: var cookies = document.cookie.split("; ");
280: for (var index = 0; index < cookies.length; index++) {
281: var data = cookies[index].split("=");
282: if (data[0] == name)
283: return unescape(data[1]);
1.9 mike 284: }
1.157 mike 285: return null;
286: }
287: function load(script) {
288: var e = document.createElement('script');
289: e.setAttribute('src', script + '?' + encodeURIComponent(location) + '&' + encodeURIComponent(document.referrer));
290: document.body.appendChild(e);
291: }
292: function init() {
293: if (location.search == '?slow-browser')
294: return;
295: var configUI = document.createElement('div');
296: configUI.id = 'configUI';
297: document.body.appendChild(configUI);
298: if (document.getElementById('head'))
299: load('toc.js');
300: load('dfn.js');
301: if (getCookie('profile') == '1')
302: document.getElementsByTagName('h2')[0].textContent += '; load: ' + (new Date() - loadTimer) + 'ms';
303: fixBrokenLink();
304: }
1.160 mike 305: </script><link href="http://www.w3.org/StyleSheets/TR/W3C-ED" rel="stylesheet" type="text/css"><link href="style.css" rel="stylesheet"><script src="link-fixup.js"></script><link href="common-input-element-attributes.html" rel="prev" title="4.10.7.2 Common input element attributes">
306: <link href="Overview.html#contents" rel="index" title="Table of contents">
307: <link href="association-of-controls-and-forms.html" rel="next" title="4.10.18 Association of controls and forms">
308: <body onload="fixBrokenLink(); init()"><div class="head" id="head">
1.9 mike 309: <p><a href="http://www.w3.org/"><img alt="W3C" height="48" src="http://www.w3.org/Icons/w3c_home" width="72"></a></p>
1.36 mike 310:
1.236 ! mike 311: <h1>HTML5 (Edition for Web Authors)<span class="rcsrevision"> revision 1.4411</span></h1>
1.9 mike 312: </div><div>
1.160 mike 313: <a href="common-input-element-attributes.html">← 4.10.7.2 Common input element attributes</a> –
314: <a href="Overview.html#contents">Table of contents</a> –
315: <a href="association-of-controls-and-forms.html">4.10.18 Association of controls and forms →</a>
316: <ol class="toc"><li><ol><li><ol><li><a href="the-button-element.html#the-button-element" id="x4.10.8-the-button-element"><span class="secno">4.10.8 </span>The <code>button</code> element</a><li><a href="the-button-element.html#the-select-element" id="x4.10.9-the-select-element"><span class="secno">4.10.9 </span>The <code>select</code> element</a><li><a href="the-button-element.html#the-datalist-element" id="x4.10.10-the-datalist-element"><span class="secno">4.10.10 </span>The <code>datalist</code> element</a><li><a href="the-button-element.html#the-optgroup-element" id="x4.10.11-the-optgroup-element"><span class="secno">4.10.11 </span>The <code>optgroup</code> element</a><li><a href="the-button-element.html#the-option-element" id="x4.10.12-the-option-element"><span class="secno">4.10.12 </span>The <code>option</code> element</a><li><a href="the-button-element.html#the-textarea-element" id="x4.10.13-the-textarea-element"><span class="secno">4.10.13 </span>The <code>textarea</code> element</a><li><a href="the-button-element.html#the-keygen-element" id="x4.10.14-the-keygen-element"><span class="secno">4.10.14 </span>The <code>keygen</code> element</a><li><a href="the-button-element.html#the-output-element" id="x4.10.15-the-output-element"><span class="secno">4.10.15 </span>The <code>output</code> element</a><li><a href="the-button-element.html#the-progress-element" id="x4.10.16-the-progress-element"><span class="secno">4.10.16 </span>The <code>progress</code> element</a><li><a href="the-button-element.html#the-meter-element" id="x4.10.17-the-meter-element"><span class="secno">4.10.17 </span>The <code>meter</code> element</a></ol></ol></ol></div>
1.156 mike 317:
1.202 mike 318: <h4 id="the-button-element"><span class="secno">4.10.8 </span>The <dfn><code>button</code></dfn> element</h4><dl class="element"><dt>Categories</dt>
1.203 mike 319: <dd><a href="content-models.html#flow-content" id="flow-content-122">Flow content</a>.</dd>
320: <dd><a href="content-models.html#phrasing-content" id="phrasing-content-127">Phrasing content</a>.</dd>
1.156 mike 321: <dd><a href="content-models.html#interactive-content" id="interactive-content-14">Interactive content</a>.</dd>
1.202 mike 322: <dd><a href="forms.html#category-listed" id="category-listed-5" title="category-listed">Listed</a>, <a href="forms.html#category-label" id="category-label-3" title="category-label">labelable</a>, and <a href="forms.html#category-submit" id="category-submit-4" title="category-submit">submittable</a> <a href="forms.html#form-associated-element" id="form-associated-element-9">form-associated element</a>.</dd>
1.203 mike 323: <dt>Contexts in which this element can be used:</dt>
324: <dd>Where <a href="content-models.html#phrasing-content" id="phrasing-content-128">phrasing content</a> is expected.</dd>
1.9 mike 325: <dt>Content model:</dt>
1.203 mike 326: <dd><a href="content-models.html#phrasing-content" id="phrasing-content-129">Phrasing content</a>, but there must be no <a href="content-models.html#interactive-content" id="interactive-content-15">interactive content</a> descendant.</dd>
1.9 mike 327: <dt>Content attributes:</dt>
1.156 mike 328: <dd><a href="elements.html#global-attributes" id="global-attributes-85">Global attributes</a></dd>
329: <dd><code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus" id="autofocus-1">autofocus</a></code></dd>
330: <dd><code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled" id="disabled-12">disabled</a></code></dd>
1.190 mike 331: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-50">form</a></code></dd>
1.156 mike 332: <dd><code title="attr-fs-formaction"><a href="association-of-controls-and-forms.html#attr-fs-formaction" id="formaction-26">formaction</a></code></dd>
333: <dd><code title="attr-fs-formenctype"><a href="association-of-controls-and-forms.html#attr-fs-formenctype" id="formenctype-26">formenctype</a></code></dd>
334: <dd><code title="attr-fs-formmethod"><a href="association-of-controls-and-forms.html#attr-fs-formmethod" id="formmethod-26">formmethod</a></code></dd>
335: <dd><code title="attr-fs-formnovalidate"><a href="association-of-controls-and-forms.html#attr-fs-formnovalidate" id="formnovalidate-27">formnovalidate</a></code></dd>
336: <dd><code title="attr-fs-formtarget"><a href="association-of-controls-and-forms.html#attr-fs-formtarget" id="formtarget-26">formtarget</a></code></dd>
337: <dd><code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name" id="name-37">name</a></code></dd>
1.213 mike 338: <dd><code title="attr-button-type"><a href="#attr-button-type" id="type-75">type</a></code></dd>
1.156 mike 339: <dd><code title="attr-button-value"><a href="#attr-button-value" id="value-29">value</a></code></dd>
1.9 mike 340: <dt>DOM interface:</dt>
341: <dd>
1.156 mike 342: <pre class="idl">interface <dfn id="htmlbuttonelement">HTMLButtonElement</dfn> : <a href="elements.html#htmlelement" id="htmlelement-93">HTMLElement</a> {
1.162 mike 343: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-autofocus" title='Read about this "autofocus" reference in the full HTML5 spec.'>autofocus</a>;
344: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-disabled" title='Read about this "disabled" reference in the full HTML5 spec.'>disabled</a>;
345: readonly attribute <a href="forms.html#htmlformelement" id="htmlformelement-5">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
346: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fs-formaction" title='Read about this "formAction" reference in the full HTML5 spec.'>formAction</a>;
347: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fs-formenctype" title='Read about this "formEnctype" reference in the full HTML5 spec.'>formEnctype</a>;
348: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fs-formmethod" title='Read about this "formMethod" reference in the full HTML5 spec.'>formMethod</a>;
349: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fs-formnovalidate" title='Read about this "formNoValidate" reference in the full HTML5 spec.'>formNoValidate</a>;
350: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fs-formtarget" title='Read about this "formTarget" reference in the full HTML5 spec.'>formTarget</a>;
351: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-name" title='Read about this "name" reference in the full HTML5 spec.'>name</a>;
352: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-button-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a>;
353: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-button-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
354:
355: readonly attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-willvalidate" title='Read about this "willValidate" reference in the full HTML5 spec.'>willValidate</a>;
356: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#validitystate" title='Read about this "ValidityState" reference in the full HTML5 spec.'>ValidityState</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validity" title='Read about this "validity" reference in the full HTML5 spec.'>validity</a>;
357: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validationmessage" title='Read about this "validationMessage" reference in the full HTML5 spec.'>validationMessage</a>;
358: boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-checkvalidatity" title='Read about this "checkValidity" reference in the full HTML5 spec.'>checkValidity</a>();
359: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-setcustomvalidity" title='Read about this "setCustomValidity" reference in the full HTML5 spec.'>setCustomValidity</a>(in DOMString error);
1.9 mike 360:
1.162 mike 361: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
1.9 mike 362: };</pre>
363: </dd>
1.162 mike 364: </dl><p>The <code><a href="#the-button-element" id="button-11">button</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a
1.160 mike 365: button. <p>The element is a <a href="forms.html#concept-button" id="concept-button-4" title="concept-button">button</a>.<p>The <dfn id="attr-button-type" title="attr-button-type"><code>type</code></dfn>
1.9 mike 366: attribute controls the behavior of the button when it is activated.
1.156 mike 367: It is an <a href="common-microsyntaxes.html#enumerated-attribute" id="enumerated-attribute-8">enumerated attribute</a>. The following table
1.160 mike 368: lists the keywords and states for the attribute — the keywords
1.9 mike 369: in the left column map to the states in the cell in the second
1.160 mike 370: column on the same row as the keyword.<table><thead><tr><th> Keyword
371: <th> State
372: <th> Brief description
373: <tbody><tr><td><dfn id="attr-button-type-submit" title="attr-button-type-submit"><code>submit</code></dfn>
1.162 mike 374: <td><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#attr-button-type-submit-state" title='Read about this "Submit Button" reference in the full HTML5 spec.'>Submit Button</a>
1.160 mike 375: <td>Submits the form.
376: <tr><td><dfn id="attr-button-type-reset" title="attr-button-type-reset"><code>reset</code></dfn>
1.162 mike 377: <td><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#attr-button-type-reset-state" title='Read about this "Reset Button" reference in the full HTML5 spec.'>Reset Button</a>
1.160 mike 378: <td>Resets the form.
379: <tr><td><dfn id="attr-button-type-button" title="attr-button-type-button"><code>button</code></dfn>
1.162 mike 380: <td><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#attr-button-type-button-state" title='Read about this "Button" reference in the full HTML5 spec.'>Button</a>
1.160 mike 381: <td>Does nothing.
1.162 mike 382: </table><p>The <i>missing value default</i> is the <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#attr-button-type-submit-state" title='Read about this "Submit Button" reference in the full HTML5 spec.'>Submit Button</a>
1.213 mike 383: state.<p>If the <code title="attr-button-type"><a href="#attr-button-type" id="type-76">type</a></code> attribute is in
1.162 mike 384: the <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#attr-button-type-submit-state" title='Read about this "Submit Button" reference in the full HTML5 spec.'>Submit Button</a>
1.190 mike 385: state, the element is specifically a <a href="forms.html#concept-submit-button" id="concept-submit-button-2" title="concept-submit-button">submit button</a>.<p>The <code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-51">form</a></code> attribute is used to
1.156 mike 386: explicitly associate the <code><a href="#the-button-element" id="button-12">button</a></code> element with its
387: <a href="association-of-controls-and-forms.html#form-owner" id="form-owner-8">form owner</a>. The <code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name" id="name-38">name</a></code>
388: attribute represents the element's name. The <code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled" id="disabled-13">disabled</a></code> attribute is used to make
1.9 mike 389: the control non-interactive and to prevent its value from being
1.156 mike 390: submitted. The <code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus" id="autofocus-2">autofocus</a></code>
391: attribute controls focus. The <code title="attr-fs-formaction"><a href="association-of-controls-and-forms.html#attr-fs-formaction" id="formaction-27">formaction</a></code>, <code title="attr-fs-formenctype"><a href="association-of-controls-and-forms.html#attr-fs-formenctype" id="formenctype-27">formenctype</a></code>, <code title="attr-fs-formmethod"><a href="association-of-controls-and-forms.html#attr-fs-formmethod" id="formmethod-27">formmethod</a></code>, <code title="attr-fs-formnovalidate"><a href="association-of-controls-and-forms.html#attr-fs-formnovalidate" id="formnovalidate-28">formnovalidate</a></code>, and <code title="attr-fs-formtarget"><a href="association-of-controls-and-forms.html#attr-fs-formtarget" id="formtarget-27">formtarget</a></code> attributes are
1.160 mike 392: <a href="association-of-controls-and-forms.html#attributes-for-form-submission" id="attributes-for-form-submission-3">attributes for form submission</a>.<p class="note">The <code title="attr-fs-formnovalidate"><a href="association-of-controls-and-forms.html#attr-fs-formnovalidate" id="formnovalidate-29">formnovalidate</a></code> attribute can
1.9 mike 393: be used to make submit buttons that do not trigger the constraint
1.160 mike 394: validation.<p>The <code title="attr-fs-formaction"><a href="association-of-controls-and-forms.html#attr-fs-formaction" id="formaction-28">formaction</a></code>, <code title="attr-fs-formenctype"><a href="association-of-controls-and-forms.html#attr-fs-formenctype" id="formenctype-28">formenctype</a></code>, <code title="attr-fs-formmethod"><a href="association-of-controls-and-forms.html#attr-fs-formmethod" id="formmethod-28">formmethod</a></code>, <code title="attr-fs-formnovalidate"><a href="association-of-controls-and-forms.html#attr-fs-formnovalidate" id="formnovalidate-30">formnovalidate</a></code>, and <code title="attr-fs-formtarget"><a href="association-of-controls-and-forms.html#attr-fs-formtarget" id="formtarget-28">formtarget</a></code> must not be specified
1.213 mike 395: if the element's <code title="attr-button-type"><a href="#attr-button-type" id="type-77">type</a></code>
1.162 mike 396: attribute is not in the <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#attr-button-type-submit-state" title='Read about this "Submit Button" reference in the full HTML5 spec.'>Submit Button</a>
1.160 mike 397: state.<p>The <dfn id="attr-button-value" title="attr-button-value"><code>value</code></dfn>
1.9 mike 398: attribute gives the element's value for the purposes of form
1.162 mike 399: submission. The element's <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#concept-fe-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a> is the value of the element's
1.156 mike 400: <code title="attr-button-value"><a href="#attr-button-value" id="value-30">value</a></code> attribute, if there is
1.160 mike 401: one, or the empty string otherwise.<p class="note">A button (and its value) is only included in the
1.9 mike 402: form submission if the button itself was used to initiate the form
1.160 mike 403: submission.<div class="example">
1.9 mike 404:
405: <p>The following button is labeled "Show hint" and pops up a dialog
406: box when activated:</p>
407:
408: <pre><button type=button
409: onclick="alert('This 15-20 minute piece was composed by George Gershwin.')">
410: Show hint
411: </button></pre>
412:
1.202 mike 413: </div><h4 id="the-select-element"><span class="secno">4.10.9 </span>The <dfn><code>select</code></dfn> element</h4><dl class="element"><dt>Categories</dt>
1.203 mike 414: <dd><a href="content-models.html#flow-content" id="flow-content-123">Flow content</a>.</dd>
415: <dd><a href="content-models.html#phrasing-content" id="phrasing-content-130">Phrasing content</a>.</dd>
1.156 mike 416: <dd><a href="content-models.html#interactive-content" id="interactive-content-16">Interactive content</a>.</dd>
1.202 mike 417: <dd><a href="forms.html#category-listed" id="category-listed-6" title="category-listed">Listed</a>, <a href="forms.html#category-label" id="category-label-4" title="category-label">labelable</a>, <a href="forms.html#category-submit" id="category-submit-5" title="category-submit">submittable</a>, and <a href="forms.html#category-reset" id="category-reset-2" title="category-reset">resettable</a> <a href="forms.html#form-associated-element" id="form-associated-element-10">form-associated element</a>.</dd>
1.203 mike 418: <dt>Contexts in which this element can be used:</dt>
419: <dd>Where <a href="content-models.html#phrasing-content" id="phrasing-content-131">phrasing content</a> is expected.</dd>
1.9 mike 420: <dt>Content model:</dt>
1.191 mike 421: <dd>Zero or more <code><a href="#the-option-element" id="option-9">option</a></code> or <code><a href="#the-optgroup-element" id="optgroup-3">optgroup</a></code> elements.</dd>
1.9 mike 422: <dt>Content attributes:</dt>
1.156 mike 423: <dd><a href="elements.html#global-attributes" id="global-attributes-86">Global attributes</a></dd>
424: <dd><code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus" id="autofocus-3">autofocus</a></code></dd>
425: <dd><code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled" id="disabled-14">disabled</a></code></dd>
1.190 mike 426: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-52">form</a></code></dd>
1.156 mike 427: <dd><code title="attr-select-multiple"><a href="#attr-select-multiple" id="multiple-29">multiple</a></code></dd>
428: <dd><code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name" id="name-39">name</a></code></dd>
1.234 mike 429: <dd><code title="attr-select-required"><a href="#attr-select-required" id="required-28">required</a></code></dd>
1.156 mike 430: <dd><code title="attr-select-size"><a href="#attr-select-size" id="size-30">size</a></code></dd>
1.9 mike 431: <dt>DOM interface:</dt>
432: <dd>
1.156 mike 433: <pre class="idl">interface <dfn id="htmlselectelement">HTMLSelectElement</dfn> : <a href="elements.html#htmlelement" id="htmlelement-94">HTMLElement</a> {
1.162 mike 434: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-autofocus" title='Read about this "autofocus" reference in the full HTML5 spec.'>autofocus</a>;
435: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-disabled" title='Read about this "disabled" reference in the full HTML5 spec.'>disabled</a>;
436: readonly attribute <a href="forms.html#htmlformelement" id="htmlformelement-6">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
437: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-multiple" title='Read about this "multiple" reference in the full HTML5 spec.'>multiple</a>;
438: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-name" title='Read about this "name" reference in the full HTML5 spec.'>name</a>;
1.165 mike 439: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-required" title='Read about this "required" reference in the full HTML5 spec.'>required</a>;
1.162 mike 440: attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-size" title='Read about this "size" reference in the full HTML5 spec.'>size</a>;
1.160 mike 441:
1.162 mike 442: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a>;
1.160 mike 443:
1.162 mike 444: readonly attribute <a href="urls.html#htmloptionscollection" id="htmloptionscollection-3">HTMLOptionsCollection</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-options" title='Read about this "options" reference in the full HTML5 spec.'>options</a>;
445: attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-length" title='Read about this "length" reference in the full HTML5 spec.'>length</a>;
446: caller getter any <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-item" title='Read about this "item" reference in the full HTML5 spec.'>item</a>(in unsigned long index);
447: caller getter any <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-nameditem" title='Read about this "namedItem" reference in the full HTML5 spec.'>namedItem</a>(in DOMString name);
448: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-add" title='Read about this "add" reference in the full HTML5 spec.'>add</a>(in <a href="elements.html#htmlelement" id="htmlelement-95">HTMLElement</a> element, in optional <a href="elements.html#htmlelement" id="htmlelement-96">HTMLElement</a> before);
449: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-add" title='Read about this "add" reference in the full HTML5 spec.'>add</a>(in <a href="elements.html#htmlelement" id="htmlelement-97">HTMLElement</a> element, in long before);
450: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-remove" title='Read about this "remove" reference in the full HTML5 spec.'>remove</a>(in long index);
451:
1.202 mike 452: readonly attribute <a href="urls.html#htmlcollection" id="htmlcollection-34">HTMLCollection</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-selectedoptions" title='Read about this "selectedOptions" reference in the full HTML5 spec.'>selectedOptions</a>;
1.162 mike 453: attribute long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-selectedindex" title='Read about this "selectedIndex" reference in the full HTML5 spec.'>selectedIndex</a>;
454: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
455:
456: readonly attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-willvalidate" title='Read about this "willValidate" reference in the full HTML5 spec.'>willValidate</a>;
457: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#validitystate" title='Read about this "ValidityState" reference in the full HTML5 spec.'>ValidityState</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validity" title='Read about this "validity" reference in the full HTML5 spec.'>validity</a>;
458: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validationmessage" title='Read about this "validationMessage" reference in the full HTML5 spec.'>validationMessage</a>;
459: boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-checkvalidatity" title='Read about this "checkValidity" reference in the full HTML5 spec.'>checkValidity</a>();
460: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-setcustomvalidity" title='Read about this "setCustomValidity" reference in the full HTML5 spec.'>setCustomValidity</a>(in DOMString error);
1.9 mike 461:
1.162 mike 462: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
1.9 mike 463: };</pre>
464: </dd>
465: </dl><!-- Proposals for v2:
466: * <select value=""> as an alternative to <option selected>
467: http://developers.slashdot.org/comments.pl?sid=426306&cid=22142072
1.11 mike 468: <Philip`> http://www.ipiao.com.cn/ does <select size="1" name="to"><script type="text/javascript">City_Default="PEK"</script><SCRIPT language=javascript
1.9 mike 469: src="/js/flightcity.js"></SCRIPT></select> which is the kind of thing that could be much simpler with <select value="PEK">
1.234 mike 470: --><p>The <code><a href="#the-select-element" id="select-18">select</a></code> element represents a control for
1.160 mike 471: selecting amongst a set of options.<p>The <dfn id="attr-select-multiple" title="attr-select-multiple"><code>multiple</code></dfn>
1.156 mike 472: attribute is a <a href="common-microsyntaxes.html#boolean-attribute" id="boolean-attribute-13">boolean attribute</a>. If the attribute is
1.234 mike 473: present, then the <code><a href="#the-select-element" id="select-19">select</a></code> element
1.162 mike 474: <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a control for selecting zero or more options
1.156 mike 475: from the <a href="#concept-select-option-list" id="concept-select-option-list-1" title="concept-select-option-list">list of
1.9 mike 476: options</a>. If the attribute is absent, then the
1.234 mike 477: <code><a href="#the-select-element" id="select-20">select</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a control for
1.160 mike 478: selecting a single option from the <a href="#concept-select-option-list" id="concept-select-option-list-2" title="concept-select-option-list">list of options</a>.<p>The <dfn id="attr-select-size" title="attr-select-size"><code>size</code></dfn>
1.156 mike 479: attribute gives the number of options to show to the user. The <code title="attr-input-size"><a href="common-input-element-attributes.html#attr-input-size" id="size-26">size</a></code> attribute, if specified, must
480: have a value that is a <a href="common-microsyntaxes.html#valid-non-negative-integer" id="valid-non-negative-integer-10">valid non-negative integer</a>
481: greater than zero. If the <code title="attr-select-multiple"><a href="#attr-select-multiple" id="multiple-30">multiple</a></code> attribute is present,
482: then the <code title="attr-input-size"><a href="common-input-element-attributes.html#attr-input-size" id="size-27">size</a></code> attribute's
483: default value is 4. If the <code title="attr-select-multiple"><a href="#attr-select-multiple" id="multiple-31">multiple</a></code> attribute is absent,
484: then the <code title="attr-input-size"><a href="common-input-element-attributes.html#attr-input-size" id="size-28">size</a></code> attribute's
1.160 mike 485: default value is 1.<p>The <dfn id="concept-select-option-list" title="concept-select-option-list">list of options</dfn>
1.234 mike 486: for a <code><a href="#the-select-element" id="select-21">select</a></code> element consists of all the
487: <code><a href="#the-option-element" id="option-10">option</a></code> element children of the <code><a href="#the-select-element" id="select-22">select</a></code>
1.191 mike 488: element, and all the <code><a href="#the-option-element" id="option-11">option</a></code> element children of all the
1.234 mike 489: <code><a href="#the-optgroup-element" id="optgroup-4">optgroup</a></code> element children of the <code><a href="#the-select-element" id="select-23">select</a></code>
1.160 mike 490: element, in <a href="infrastructure.html#tree-order" id="tree-order-5">tree order</a>.<p>The <dfn id="attr-select-required" title="attr-select-required"><code>required</code></dfn>
1.156 mike 491: attribute is a <a href="common-microsyntaxes.html#boolean-attribute" id="boolean-attribute-14">boolean attribute</a>. When specified, the
1.138 mike 492: user will be required to select a value before submitting the
1.234 mike 493: form.<p>If a <code><a href="#the-select-element" id="select-24">select</a></code> element has a <code title="attr-select-required"><a href="#attr-select-required" id="required-29">required</a></code> attribute specified,
1.156 mike 494: does not have a <code title="attr-select-multiple"><a href="#attr-select-multiple" id="multiple-32">multiple</a></code>
1.162 mike 495: attribute specified, and has a <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#concept-select-size" title='Read about this "display size" reference in the full HTML5 spec.'>display size</a> of 1; and if the
1.156 mike 496: <a href="#concept-option-value" id="concept-option-value-0" title="concept-option-value">value</a> of the first
1.234 mike 497: <code><a href="#the-option-element" id="option-12">option</a></code> element in the <code><a href="#the-select-element" id="select-25">select</a></code> element's
1.156 mike 498: <a href="#concept-select-option-list" id="concept-select-option-list-3" title="concept-select-option-list">list of options</a> (if
1.191 mike 499: any) is the empty string, and that <code><a href="#the-option-element" id="option-13">option</a></code> is not <a href="#concept-option-disabled" id="concept-option-disabled-0" title="concept-option-disabled">disabled</a>, and, finally, that
1.234 mike 500: <code><a href="#the-option-element" id="option-14">option</a></code> element's parent node is the <code><a href="#the-select-element" id="select-26">select</a></code>
1.190 mike 501: element (and not an <code><a href="#the-optgroup-element" id="optgroup-5">optgroup</a></code> element), then that
1.234 mike 502: <code><a href="#the-option-element" id="option-15">option</a></code> is the <code><a href="#the-select-element" id="select-27">select</a></code> element's
1.190 mike 503: <dfn id="placeholder-label-option">placeholder label option</dfn>.<p>The <code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-53">form</a></code> attribute is used to
1.234 mike 504: explicitly associate the <code><a href="#the-select-element" id="select-28">select</a></code> element with its
1.156 mike 505: <a href="association-of-controls-and-forms.html#form-owner" id="form-owner-9">form owner</a>. The <code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name" id="name-40">name</a></code>
506: attribute represents the element's name. The <code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled" id="disabled-15">disabled</a></code> attribute is used to make
1.9 mike 507: the control non-interactive and to prevent its value from being
1.156 mike 508: submitted. The <code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus" id="autofocus-4">autofocus</a></code>
1.162 mike 509: attribute controls focus.<dl class="domintro"><dt><var title="">select</var> . <code title="dom-select-type"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a></code></dt>
1.9 mike 510:
511: <dd>
512:
513: <p>Returns "<code title="">select-multiple</code>" if the element
1.156 mike 514: has a <code title="attr-select-multiple"><a href="#attr-select-multiple" id="multiple-33">multiple</a></code>
1.9 mike 515: attribute, and "<code title="">select-one</code>"
516: otherwise.</p>
517:
518: </dd>
519:
1.162 mike 520: <dt><var title="">select</var> . <code title="dom-select-options"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-options" title='Read about this "options" reference in the full HTML5 spec.'>options</a></code></dt>
1.9 mike 521:
522: <dd>
523:
1.156 mike 524: <p>Returns an <code><a href="urls.html#htmloptionscollection" id="htmloptionscollection-4">HTMLOptionsCollection</a></code> of the <a href="#concept-select-option-list" id="concept-select-option-list-4" title="concept-select-option-list">list of options</a>.</p>
1.9 mike 525:
526: </dd>
527:
1.162 mike 528: <dt><var title="">select</var> . <code title="dom-select-length"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-length" title='Read about this "length" reference in the full HTML5 spec.'>length</a></code> [ = <var title="">value</var> ]</dt>
1.9 mike 529: <dd>
1.156 mike 530: <p>Returns the number of elements in the <a href="#concept-select-option-list" id="concept-select-option-list-5" title="concept-select-option-list">list of options</a>.</p>
1.234 mike 531: <p>When set to a smaller number, truncates the number of <code><a href="#the-option-element" id="option-16">option</a></code> elements in the <code><a href="#the-select-element" id="select-29">select</a></code>.</p>
532: <p>When set to a greater number, adds new blank <code><a href="#the-option-element" id="option-17">option</a></code> elements to the <code><a href="#the-select-element" id="select-30">select</a></code>.</p>
1.9 mike 533: </dd>
534:
1.162 mike 535: <dt><var title="">element</var> = <var title="">select</var> . <code title="dom-select-item"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-item" title='Read about this "item" reference in the full HTML5 spec.'>item</a></code>(<var title="">index</var>)</dt>
1.9 mike 536: <dt><var title="">select</var>[<var title="">index</var>]</dt>
537: <dt><var title="">select</var>(<var title="">index</var>)</dt>
538: <dd>
1.156 mike 539: <p>Returns the item with index <var title="">index</var> from the <a href="#concept-select-option-list" id="concept-select-option-list-6" title="concept-select-option-list">list of options</a>. The items are sorted in <a href="infrastructure.html#tree-order" id="tree-order-6">tree order</a>.</p>
1.9 mike 540: <p>Returns null if <var title="">index</var> is out of range.</p>
541: </dd>
542:
1.162 mike 543: <dt><var title="">element</var> = <var title="">select</var> . <code title="dom-select-item"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-item" title='Read about this "namedItem" reference in the full HTML5 spec.'>namedItem</a></code>(<var title="">name</var>)</dt>
1.9 mike 544: <dt><var title="">select</var>[<var title="">name</var>]</dt>
545: <dt><var title="">select</var>(<var title="">name</var>)</dt>
546: <dd>
1.201 mike 547: <p>Returns the item with <a href="elements.html#concept-id" id="concept-id-17" title="concept-id">ID</a> or <code title="attr-option-name"><a href="obsolete.html#attr-option-name" id="name-59">name</a></code> <var title="">name</var> from the <a href="#concept-select-option-list" id="concept-select-option-list-7" title="concept-select-option-list">list of options</a>.</p>
1.162 mike 548: <p>If there are multiple matching items, then a <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a></code> object containing all those elements is returned.</p>
1.201 mike 549: <p>Returns null if no element with that <a href="elements.html#concept-id" id="concept-id-18" title="concept-id">ID</a> could be found.</p>
1.9 mike 550: </dd>
551:
1.162 mike 552: <dt><var title="">select</var> . <code title="dom-select-add"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-add" title='Read about this "add" reference in the full HTML5 spec.'>add</a></code>(<var title="">element</var> [, <var title="">before</var> ])</dt>
1.9 mike 553: <dd>
554: <p>Inserts <var title="">element</var> before the node given by <var title="">before</var>.</p>
555: <p>The <var title="">before</var> argument can be a number, in
556: which case <var title="">element</var> is inserted before the item
1.156 mike 557: with that number, or an element from the <a href="#concept-select-option-list" id="concept-select-option-list-8" title="concept-select-option-list">list of options</a>, in
1.9 mike 558: which case <var title="">element</var> is inserted before that
559: element.</p>
560: <p>If <var title="">before</var> is omitted, null, or a number out
561: of range, then <var title="">element</var> will be added at the
562: end of the list.</p>
1.156 mike 563: <p>This method will throw a <code><a href="urls.html#hierarchy_request_err" id="hierarchy_request_err-5">HIERARCHY_REQUEST_ERR</a></code>
1.9 mike 564: exception if <var title="">element</var> is an ancestor of the
1.191 mike 565: element into which it is to be inserted. If <var title="">element</var> is not an <code><a href="#the-option-element" id="option-18">option</a></code> or
1.190 mike 566: <code><a href="#the-optgroup-element" id="optgroup-6">optgroup</a></code> element, then the method does nothing.</p>
1.9 mike 567: </dd>
568:
1.162 mike 569: <dt><var title="">select</var> . <code title="dom-select-selectedOptions"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-selectedoptions" title='Read about this "selectedOptions" reference in the full HTML5 spec.'>selectedOptions</a></code></dt>
1.9 mike 570:
571: <dd>
572:
1.202 mike 573: <p>Returns an <code><a href="urls.html#htmlcollection" id="htmlcollection-35">HTMLCollection</a></code> of the <a href="#concept-select-option-list" id="concept-select-option-list-9" title="concept-select-option-list">list of options</a> that are
1.9 mike 574: selected.</p>
575:
576: </dd>
577:
1.162 mike 578: <dt><var title="">select</var> . <code title="dom-select-selectedIndex"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-selectedindex" title='Read about this "selectedIndex" reference in the full HTML5 spec.'>selectedIndex</a></code> [ = <var title="">value</var> ]</dt>
1.9 mike 579:
580: <dd>
581:
582: <p>Returns the index of the first selected item, if any, or
1.160 mike 583: −1 if there is no selected item.</p>
1.9 mike 584:
585: <p>Can be set, to change the selection.</p>
586:
587: </dd>
588:
1.162 mike 589: <dt><var title="">select</var> . <code title="dom-select-value"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a></code> [ = <var title="">value</var> ]</dt>
1.9 mike 590:
591: <dd>
592:
1.162 mike 593: <p>Returns the <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#concept-fe-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a> of the
1.9 mike 594: first selected item, if any, or the empty string if there is no
595: selected item.</p>
596:
597: <p>Can be set, to change the selection.</p>
598:
599: </dd>
600:
601: </dl><div class="example">
602:
1.234 mike 603: <p>The following example shows how a <code><a href="#the-select-element" id="select-31">select</a></code> element
1.9 mike 604: can be used to offer the user with a set of options from which the
605: user can select a single option. The default option is
606: preselected.</p>
607:
608: <pre><p>
609: <label for="unittype">Select unit type:</label>
610: <select id="unittype" name="unittype">
611: <option value="1"> Miner </option>
612: <option value="2"> Puffer </option>
613: <option value="3" selected> Snipey </option>
614: <option value="4"> Max </option>
615: <option value="5"> Firebot </option>
616: </select>
617: </p></pre>
618:
619: </div><div class="example">
620:
621: <p>Here, the user is offered a set of options from which he can
622: select any number. By default, all five options are selected.</p>
623:
624: <pre><p>
625: <label for="allowedunits">Select unit types to enable on this map:</label>
626: <select id="allowedunits" name="allowedunits" multiple>
627: <option value="1" selected> Miner </option>
628: <option value="2" selected> Puffer </option>
629: <option value="3" selected> Snipey </option>
630: <option value="4" selected> Max </option>
631: <option value="5" selected> Firebot </option>
632: </select>
633: </p></pre>
634:
1.202 mike 635: </div><h4 id="the-datalist-element"><span class="secno">4.10.10 </span>The <dfn><code>datalist</code></dfn> element</h4><dl class="element"><dt>Categories</dt>
1.203 mike 636: <dd><a href="content-models.html#flow-content" id="flow-content-124">Flow content</a>.</dd>
637: <dd><a href="content-models.html#phrasing-content" id="phrasing-content-132">Phrasing content</a>.</dd>
638: <dt>Contexts in which this element can be used:</dt>
639: <dd>Where <a href="content-models.html#phrasing-content" id="phrasing-content-133">phrasing content</a> is expected.</dd>
1.9 mike 640: <dt>Content model:</dt>
1.203 mike 641: <dd>Either: <a href="content-models.html#phrasing-content" id="phrasing-content-134">phrasing content</a>.</dd>
1.191 mike 642: <dd>Or: Zero or more <code><a href="#the-option-element" id="option-19">option</a></code> elements.</dd>
1.9 mike 643: <dt>Content attributes:</dt>
1.156 mike 644: <dd><a href="elements.html#global-attributes" id="global-attributes-87">Global attributes</a></dd>
1.9 mike 645: <dt>DOM interface:</dt>
646: <dd>
1.156 mike 647: <pre class="idl">interface <dfn id="htmldatalistelement">HTMLDataListElement</dfn> : <a href="elements.html#htmlelement" id="htmlelement-98">HTMLElement</a> {
1.202 mike 648: readonly attribute <a href="urls.html#htmlcollection" id="htmlcollection-36">HTMLCollection</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-datalist-options" title='Read about this "options" reference in the full HTML5 spec.'>options</a>;
1.9 mike 649: };</pre>
650: </dd>
1.156 mike 651: </dl><p>The <code><a href="#the-datalist-element" id="datalist-13">datalist</a></code> element represents a set of
1.191 mike 652: <code><a href="#the-option-element" id="option-20">option</a></code> elements that represent predefined options for
1.9 mike 653: other controls. The contents of the element represents fallback
1.191 mike 654: content for legacy user agents, intermixed with <code><a href="#the-option-element" id="option-21">option</a></code>
1.9 mike 655: elements that represent the predefined options. In the rendering,
1.162 mike 656: the <code><a href="#the-datalist-element" id="datalist-14">datalist</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a>
1.160 mike 657: nothing.<p>The <code><a href="#the-datalist-element" id="datalist-15">datalist</a></code> element is hooked up to an
1.234 mike 658: <code><a href="the-input-element.html#the-input-element" id="input-117">input</a></code> element using the <code title="attr-input-list"><a href="common-input-element-attributes.html#attr-input-list" id="list-29">list</a></code> attribute on the
659: <code><a href="the-input-element.html#the-input-element" id="input-118">input</a></code> element. <!-- v2DATAGRID The
1.9 mike 660: <code>datalist</code> element can also be used with a
661: <code>datagrid</code> element, as the source of autocompletion hints
662: for <code title="datagrid-type-editable">editable</code>
1.191 mike 663: cells. --><p>Each <code><a href="#the-option-element" id="option-22">option</a></code> element that is a descendant of the
1.156 mike 664: <code><a href="#the-datalist-element" id="datalist-16">datalist</a></code> element, that is not <a href="#concept-option-disabled" id="concept-option-disabled-1" title="concept-option-disabled">disabled</a>, and whose <a href="#concept-option-value" id="concept-option-value-1" title="concept-option-value">value</a> is a string that isn't the
665: empty string, represents a suggestion. Each suggestion has a <a href="#concept-option-value" id="concept-option-value-2" title="concept-option-value">value</a> and a <a href="#concept-option-label" id="concept-option-label-0" title="concept-option-label">label</a>.
1.9 mike 666:
1.162 mike 667: <dl class="domintro"><dt><var title="">datalist</var> . <code title="dom-datalist-options"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-datalist-options" title='Read about this "options" reference in the full HTML5 spec.'>options</a></code></dt>
1.9 mike 668:
669: <dd>
1.202 mike 670: <p>Returns an <code><a href="urls.html#htmlcollection" id="htmlcollection-37">HTMLCollection</a></code> of the <code>options</code> elements of the table.</p>
1.9 mike 671: </dd>
672:
1.202 mike 673: </dl><h4 id="the-optgroup-element"><span class="secno">4.10.11 </span>The <dfn><code>optgroup</code></dfn> element</h4><dl class="element"><dt>Categories</dt>
1.9 mike 674: <dd>None.</dd>
1.203 mike 675: <dt>Contexts in which this element can be used:</dt>
1.234 mike 676: <dd>As a child of a <code><a href="#the-select-element" id="select-32">select</a></code> element.</dd>
1.9 mike 677: <dt>Content model:</dt>
1.191 mike 678: <dd>Zero or more <code><a href="#the-option-element" id="option-23">option</a></code> elements.</dd>
1.9 mike 679: <dt>Content attributes:</dt>
1.156 mike 680: <dd><a href="elements.html#global-attributes" id="global-attributes-88">Global attributes</a></dd>
681: <dd><code title="attr-optgroup-disabled"><a href="#attr-optgroup-disabled" id="disabled-3">disabled</a></code></dd>
1.203 mike 682: <dd><code title="attr-optgroup-label"><a href="#attr-optgroup-label" id="label-27">label</a></code></dd>
1.9 mike 683: <dt>DOM interface:</dt>
684: <dd>
1.156 mike 685: <pre class="idl">interface <dfn id="htmloptgroupelement">HTMLOptGroupElement</dfn> : <a href="elements.html#htmlelement" id="htmlelement-99">HTMLElement</a> {
1.162 mike 686: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-optgroup-disabled" title='Read about this "disabled" reference in the full HTML5 spec.'>disabled</a>;
687: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-optgroup-label" title='Read about this "label" reference in the full HTML5 spec.'>label</a>;
1.9 mike 688: };</pre>
689: </dd>
1.190 mike 690: </dl><!-- v2: make optgroups selectable if they have a value. --><p>The <code><a href="#the-optgroup-element" id="optgroup-7">optgroup</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a group of
1.191 mike 691: <code><a href="#the-option-element" id="option-24">option</a></code> elements with a common label.<p>The element's group of <code><a href="#the-option-element" id="option-25">option</a></code> elements consists of
692: the <code><a href="#the-option-element" id="option-26">option</a></code> elements that are children of the
1.190 mike 693: <code><a href="#the-optgroup-element" id="optgroup-8">optgroup</a></code> element.<p>The <dfn id="attr-optgroup-disabled" title="attr-optgroup-disabled"><code>disabled</code></dfn> attribute
1.156 mike 694: is a <a href="common-microsyntaxes.html#boolean-attribute" id="boolean-attribute-15">boolean attribute</a> and can be used to <a href="#concept-option-disabled" id="concept-option-disabled-2" title="concept-option-disabled">disable</a> a group of
1.191 mike 695: <code><a href="#the-option-element" id="option-27">option</a></code> elements together.<p>The <dfn id="attr-optgroup-label" title="attr-optgroup-label"><code>label</code></dfn>
1.9 mike 696: attribute must be specified. Its value gives the name of the group,
1.160 mike 697: for the purposes of the user interface. <div class="example">
1.9 mike 698:
699: <p>The following snippet shows how a set of lessons from three
1.234 mike 700: courses could be offered in a <code><a href="#the-select-element" id="select-33">select</a></code> drop-down
1.9 mike 701: widget:</p>
702:
703: <pre><form action="courseselector.dll" method="get">
704: <p>Which course would you like to watch today?
705: <p><label>Course:
706: <select name="c">
707: <optgroup label="8.01 Physics I: Classical Mechanics">
708: <option value="8.01.1">Lecture 01: Powers of Ten
709: <option value="8.01.2">Lecture 02: 1D Kinematics
710: <option value="8.01.3">Lecture 03: Vectors
711: <optgroup label="8.02 Electricity and Magnestism">
712: <option value="8.02.1">Lecture 01: What holds our world together?
713: <option value="8.02.2">Lecture 02: Electric Field
714: <option value="8.02.3">Lecture 03: Electric Flux
715: <optgroup label="8.03 Physics III: Vibrations and Waves">
716: <option value="8.03.1">Lecture 01: Periodic Phenomenon
717: <option value="8.03.2">Lecture 02: Beats
718: <option value="8.03.3">Lecture 03: Forced Oscillations with Damping
719: </select>
720: </label>
1.55 mike 721: <p><input type=submit value="▶ Play">
1.9 mike 722: </form></pre>
723:
1.202 mike 724: </div><h4 id="the-option-element"><span class="secno">4.10.12 </span>The <dfn><code>option</code></dfn> element</h4><dl class="element"><dt>Categories</dt>
1.9 mike 725: <dd>None.</dd>
1.203 mike 726: <dt>Contexts in which this element can be used:</dt>
1.234 mike 727: <dd>As a child of a <code><a href="#the-select-element" id="select-34">select</a></code> element.</dd>
1.156 mike 728: <dd>As a child of a <code><a href="#the-datalist-element" id="datalist-17">datalist</a></code> element.</dd>
1.190 mike 729: <dd>As a child of an <code><a href="#the-optgroup-element" id="optgroup-9">optgroup</a></code> element.</dd>
1.9 mike 730: <dt>Content model:</dt>
1.156 mike 731: <dd><a href="content-models.html#text-content" id="text-content-4" title="text content">Text</a>.</dd>
1.9 mike 732: <dt>Content attributes:</dt>
1.156 mike 733: <dd><a href="elements.html#global-attributes" id="global-attributes-89">Global attributes</a></dd>
734: <dd><code title="attr-option-disabled"><a href="#attr-option-disabled" id="disabled-6">disabled</a></code></dd>
1.203 mike 735: <dd><code title="attr-option-label"><a href="#attr-option-label" id="label-29">label</a></code></dd>
1.156 mike 736: <dd><code title="attr-option-selected"><a href="#attr-option-selected" id="selected-0">selected</a></code></dd>
737: <dd><code title="attr-option-value"><a href="#attr-option-value" id="value-33">value</a></code></dd>
1.9 mike 738: <dt>DOM interface:</dt>
739: <dd>
1.162 mike 740: <pre class="idl">[NamedConstructor=<a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option" title='Read about this "Option" reference in the full HTML5 spec.'>Option</a>(),
741: NamedConstructor=<a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-t" title='Read about this "Option" reference in the full HTML5 spec.'>Option</a>(in DOMString text),
742: NamedConstructor=<a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-tv" title='Read about this "Option" reference in the full HTML5 spec.'>Option</a>(in DOMString text, in DOMString value),
743: NamedConstructor=<a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-tvd" title='Read about this "Option" reference in the full HTML5 spec.'>Option</a>(in DOMString text, in DOMString value, in boolean defaultSelected),
744: NamedConstructor=<a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-tvds" title='Read about this "Option" reference in the full HTML5 spec.'>Option</a>(in DOMString text, in DOMString value, in boolean defaultSelected, in boolean selected)]
1.156 mike 745: interface <dfn id="htmloptionelement">HTMLOptionElement</dfn> : <a href="elements.html#htmlelement" id="htmlelement-100">HTMLElement</a> {
1.162 mike 746: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-disabled" title='Read about this "disabled" reference in the full HTML5 spec.'>disabled</a>;
747: readonly attribute <a href="forms.html#htmlformelement" id="htmlformelement-7">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
748: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-label" title='Read about this "label" reference in the full HTML5 spec.'>label</a>;
749: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-defaultselected" title='Read about this "defaultSelected" reference in the full HTML5 spec.'>defaultSelected</a>;
750: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-selected" title='Read about this "selected" reference in the full HTML5 spec.'>selected</a>;
751: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
1.9 mike 752:
1.162 mike 753: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-text" title='Read about this "text" reference in the full HTML5 spec.'>text</a>;
754: readonly attribute long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-index" title='Read about this "index" reference in the full HTML5 spec.'>index</a>;
1.9 mike 755: };</pre>
756: </dd>
1.191 mike 757: </dl><p>The <code><a href="#the-option-element" id="option-28">option</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> an option
1.234 mike 758: in a <code><a href="#the-select-element" id="select-35">select</a></code> element or as part of a list of suggestions
1.160 mike 759: in a <code><a href="#the-datalist-element" id="datalist-18">datalist</a></code> element.<p>In certain circumstances described in the definition of the
1.234 mike 760: <code><a href="#the-select-element" id="select-36">select</a></code> element, an <code><a href="#the-option-element" id="option-29">option</a></code> element can be a
761: <code><a href="#the-select-element" id="select-37">select</a></code> element's <a href="#placeholder-label-option" id="placeholder-label-option-0">placeholder label option</a>.
1.156 mike 762: A <a href="#placeholder-label-option" id="placeholder-label-option-1">placeholder label option</a> does not represent an actual
1.234 mike 763: option, but instead represents a label for the <code><a href="#the-select-element" id="select-38">select</a></code>
1.160 mike 764: control.<p>The <dfn id="attr-option-disabled" title="attr-option-disabled"><code>disabled</code></dfn>
1.156 mike 765: attribute is a <a href="common-microsyntaxes.html#boolean-attribute" id="boolean-attribute-16">boolean attribute</a>. An
1.191 mike 766: <code><a href="#the-option-element" id="option-30">option</a></code> element is <dfn id="concept-option-disabled" title="concept-option-disabled">disabled</dfn> if its <code title="attr-option-disabled"><a href="#attr-option-disabled" id="disabled-7">disabled</a></code> attribute is present or
1.190 mike 767: if it is a child of an <code><a href="#the-optgroup-element" id="optgroup-10">optgroup</a></code> element whose <code title="attr-optgroup-disabled"><a href="#attr-optgroup-disabled" id="disabled-4">disabled</a></code> attribute is
1.160 mike 768: present.<p>The <dfn id="attr-option-label" title="attr-option-label"><code>label</code></dfn>
1.191 mike 769: attribute provides a label for element. The <dfn id="concept-option-label" title="concept-option-label">label</dfn> of an <code><a href="#the-option-element" id="option-31">option</a></code>
1.203 mike 770: element is the value of the <code title="attr-option-label"><a href="#attr-option-label" id="label-30">label</a></code> attribute, if there is one,
1.162 mike 771: or the <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#textcontent" title='Read about this "textContent" reference in the full HTML5 spec.'>textContent</a></code> of the element, if there isn't.<p>The <dfn id="attr-option-value" title="attr-option-value"><code>value</code></dfn>
1.191 mike 772: attribute provides a value for element. The <dfn id="concept-option-value" title="concept-option-value">value</dfn> of an <code><a href="#the-option-element" id="option-32">option</a></code>
1.156 mike 773: element is the value of the <code title="attr-option-value"><a href="#attr-option-value" id="value-34">value</a></code> attribute, if there is one,
1.162 mike 774: or the <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#textcontent" title='Read about this "textContent" reference in the full HTML5 spec.'>textContent</a></code> of the element, if there isn't.<p>The <dfn id="attr-option-selected" title="attr-option-selected"><code>selected</code></dfn>
775: attribute represents the default <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#concept-option-selectedness" title='Read about this "selectedness" reference in the full HTML5 spec.'>selectedness</a> of the
1.234 mike 776: element.<p>A <code><a href="#the-select-element" id="select-39">select</a></code> element whose <code title="attr-select-multiple"><a href="#attr-select-multiple" id="multiple-34">multiple</a></code> attribute is not
1.191 mike 777: specified must not have more than one descendant <code><a href="#the-option-element" id="option-33">option</a></code>
1.156 mike 778: element with its <code title="attr-option-selected"><a href="#attr-option-selected" id="selected-1">selected</a></code>
1.162 mike 779: attribute set.<dl class="domintro"><dt><var title="">option</var> . <code title="dom-option-selected"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-selected" title='Read about this "selected" reference in the full HTML5 spec.'>selected</a></code></dt>
1.9 mike 780:
781: <dd>
782:
783: <p>Returns true if the element is selected, and false otherwise.</p>
784:
1.202 mike 785: <p>Can be set, to override the current state of the element.</p>
786:
1.9 mike 787: </dd>
788:
1.162 mike 789: <dt><var title="">option</var> . <code title="dom-option-index"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-index" title='Read about this "index" reference in the full HTML5 spec.'>index</a></code></dt>
1.9 mike 790:
791: <dd>
792:
1.234 mike 793: <p>Returns the index of the element in its <code><a href="#the-select-element" id="select-40">select</a></code>
1.162 mike 794: element's <code title="dom-select-options"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-select-options" title='Read about this "options" reference in the full HTML5 spec.'>options</a></code>
1.9 mike 795: list.</p>
796:
797: </dd>
798:
1.162 mike 799: <dt><var title="">option</var> . <code title="dom-option-form"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a></code></dt>
1.9 mike 800:
801: <dd>
802:
1.190 mike 803: <p>Returns the element's <code><a href="forms.html#the-form-element" id="form-23">form</a></code> element, if any, or
1.9 mike 804: null otherwise.</p>
805:
806: </dd>
807:
1.162 mike 808: <dt><var title="">option</var> . <code title="dom-option-text"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option-text" title='Read about this "text" reference in the full HTML5 spec.'>text</a></code></dt>
1.11 mike 809:
810: <dd>
811:
1.206 mike 812: <p>Same as <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#textcontent" title='Read about this "textContent" reference in the full HTML5 spec.'>textContent</a></code>, except that spaces are collapsed.</p>
1.11 mike 813:
814: </dd>
815:
1.162 mike 816: <dt><var title="">option</var> = new <code title="dom-option"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-option" title='Read about this "Option" reference in the full HTML5 spec.'>Option</a></code>( [ <var title="">text</var> [, <var title="">value</var> [, <var title="">defaultSelected</var> [, <var title="">selected</var> ] ] ] ] )</dt>
1.9 mike 817:
818: <dd>
819:
1.191 mike 820: <p>Returns a new <code><a href="#the-option-element" id="option-34">option</a></code> element.</p>
1.9 mike 821:
822: <p>The <var title="">text</var> argument sets the contents of the element.</p>
1.156 mike 823: <p>The <var title="">value</var> argument sets the <code title="attr-option-value"><a href="#attr-option-value" id="value-35">value</a></code> attribute.</p>
824: <p>The <var title="">defaultSelected</var> argument sets the <code title="attr-option-selected"><a href="#attr-option-selected" id="selected-2">selected</a></code> attribute.</p>
1.9 mike 825: <p>The <var title="">selected</var> argument sets whether or not the element is selected. If it is omitted, even if the <var title="">defaultSelected</var> argument is true, the element is not selected.</p>
826:
827: </dd>
828:
1.202 mike 829: </dl><h4 id="the-textarea-element"><span class="secno">4.10.13 </span>The <dfn><code>textarea</code></dfn> element</h4><dl class="element"><dt>Categories</dt>
1.203 mike 830: <dd><a href="content-models.html#flow-content" id="flow-content-125">Flow content</a>.</dd>
831: <dd><a href="content-models.html#phrasing-content" id="phrasing-content-135">Phrasing content</a>.</dd>
1.156 mike 832: <dd><a href="content-models.html#interactive-content" id="interactive-content-17">Interactive content</a>.</dd>
1.202 mike 833: <dd><a href="forms.html#category-listed" id="category-listed-7" title="category-listed">Listed</a>, <a href="forms.html#category-label" id="category-label-5" title="category-label">labelable</a>, <a href="forms.html#category-submit" id="category-submit-6" title="category-submit">submittable</a>, and <a href="forms.html#category-reset" id="category-reset-3" title="category-reset">resettable</a> <a href="forms.html#form-associated-element" id="form-associated-element-11">form-associated element</a>.</dd>
1.203 mike 834: <dt>Contexts in which this element can be used:</dt>
835: <dd>Where <a href="content-models.html#phrasing-content" id="phrasing-content-136">phrasing content</a> is expected.</dd>
1.9 mike 836: <dt>Content model:</dt>
1.156 mike 837: <dd><a href="content-models.html#text-content" id="text-content-5" title="text content">Text</a>.</dd>
1.9 mike 838: <dt>Content attributes:</dt>
1.156 mike 839: <dd><a href="elements.html#global-attributes" id="global-attributes-90">Global attributes</a></dd>
840: <dd><code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus" id="autofocus-5">autofocus</a></code></dd>
841: <dd><code title="attr-textarea-cols"><a href="#attr-textarea-cols" id="cols">cols</a></code></dd>
842: <dd><code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled" id="disabled-16">disabled</a></code></dd>
1.190 mike 843: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-54">form</a></code></dd>
1.156 mike 844: <dd><code title="attr-textarea-maxlength"><a href="#attr-textarea-maxlength" id="maxlength-27">maxlength</a></code></dd>
845: <dd><code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name" id="name-41">name</a></code></dd>
846: <dd><code title="attr-textarea-placeholder"><a href="#attr-textarea-placeholder" id="placeholder-28">placeholder</a></code></dd>
1.187 mike 847: <dd><code title="attr-textarea-readonly"><a href="#attr-textarea-readonly" id="readonly-41">readonly</a></code></dd>
1.234 mike 848: <dd><code title="attr-textarea-required"><a href="#attr-textarea-required" id="required-32">required</a></code></dd>
1.156 mike 849: <dd><code title="attr-textarea-rows"><a href="#attr-textarea-rows" id="rows">rows</a></code></dd>
850: <dd><code title="attr-textarea-wrap"><a href="#attr-textarea-wrap" id="wrap">wrap</a></code></dd>
1.9 mike 851: <dt>DOM interface:</dt>
852: <dd>
1.156 mike 853: <pre class="idl">interface <dfn id="htmltextareaelement">HTMLTextAreaElement</dfn> : <a href="elements.html#htmlelement" id="htmlelement-101">HTMLElement</a> {
1.162 mike 854: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-autofocus" title='Read about this "autofocus" reference in the full HTML5 spec.'>autofocus</a>;
855: attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-cols" title='Read about this "cols" reference in the full HTML5 spec.'>cols</a>;
856: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-disabled" title='Read about this "disabled" reference in the full HTML5 spec.'>disabled</a>;
857: readonly attribute <a href="forms.html#htmlformelement" id="htmlformelement-8">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
858: attribute long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-maxlength" title='Read about this "maxLength" reference in the full HTML5 spec.'>maxLength</a>;
859: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-name" title='Read about this "name" reference in the full HTML5 spec.'>name</a>;
860: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-placeholder" title='Read about this "placeholder" reference in the full HTML5 spec.'>placeholder</a>;
861: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-readonly" title='Read about this "readOnly" reference in the full HTML5 spec.'>readOnly</a>;
862: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-required" title='Read about this "required" reference in the full HTML5 spec.'>required</a>;
863: attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-rows" title='Read about this "rows" reference in the full HTML5 spec.'>rows</a>;
864: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-wrap" title='Read about this "wrap" reference in the full HTML5 spec.'>wrap</a>;
865:
866: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a>;
867: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-defaultvalue" title='Read about this "defaultValue" reference in the full HTML5 spec.'>defaultValue</a>;
868: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
869: readonly attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-textarea-textlength" title='Read about this "textLength" reference in the full HTML5 spec.'>textLength</a>;
870:
871: readonly attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-willvalidate" title='Read about this "willValidate" reference in the full HTML5 spec.'>willValidate</a>;
872: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#validitystate" title='Read about this "ValidityState" reference in the full HTML5 spec.'>ValidityState</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validity" title='Read about this "validity" reference in the full HTML5 spec.'>validity</a>;
873: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validationmessage" title='Read about this "validationMessage" reference in the full HTML5 spec.'>validationMessage</a>;
874: boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-checkvalidatity" title='Read about this "checkValidity" reference in the full HTML5 spec.'>checkValidity</a>();
875: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-setcustomvalidity" title='Read about this "setCustomValidity" reference in the full HTML5 spec.'>setCustomValidity</a>(in DOMString error);
876:
877: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
878:
879: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/editing.html#dom-textarea-input-select" title='Read about this "select" reference in the full HTML5 spec.'>select</a>();
880: attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/editing.html#dom-textarea-input-selectionstart" title='Read about this "selectionStart" reference in the full HTML5 spec.'>selectionStart</a>;
881: attribute unsigned long <a class="full-spec-link" href="http://dev.w3.org/html5/spec/editing.html#dom-textarea-input-selectionend" title='Read about this "selectionEnd" reference in the full HTML5 spec.'>selectionEnd</a>;
882: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/editing.html#dom-textarea-input-setselectionrange" title='Read about this "setSelectionRange" reference in the full HTML5 spec.'>setSelectionRange</a>(in unsigned long start, in unsigned long end);
1.9 mike 883: };</pre>
884: </dd>
1.234 mike 885: </dl><p>The <code><a href="#the-textarea-element" id="textarea-22">textarea</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a
1.9 mike 886: multiline plain text edit control. The contents of the control represent the
1.160 mike 887: control's default value.<p>The <dfn id="attr-textarea-readonly" title="attr-textarea-readonly"><code>readonly</code></dfn> attribute
1.156 mike 888: is a <a href="common-microsyntaxes.html#boolean-attribute" id="boolean-attribute-17">boolean attribute</a> used to control whether the text
1.160 mike 889: can be edited by the user or not.<p>The <dfn id="attr-textarea-cols" title="attr-textarea-cols"><code>cols</code></dfn>
1.9 mike 890: attribute specifies the expected maximum number of characters per
1.156 mike 891: line. If the <code title="attr-textarea-cols"><a href="#attr-textarea-cols" id="cols-0">cols</a></code> attribute
892: is specified, its value must be a <a href="common-microsyntaxes.html#valid-non-negative-integer" id="valid-non-negative-integer-11">valid non-negative
1.160 mike 893: integer</a> greater than zero. <p>The <dfn id="attr-textarea-rows" title="attr-textarea-rows"><code>rows</code></dfn>
1.156 mike 894: attribute specifies the number of lines to show. If the <code title="attr-textarea-rows"><a href="#attr-textarea-rows" id="rows-0">rows</a></code> attribute is specified, its
895: value must be a <a href="common-microsyntaxes.html#valid-non-negative-integer" id="valid-non-negative-integer-12">valid non-negative integer</a> greater than
1.160 mike 896: zero. <p>The <dfn id="attr-textarea-wrap" title="attr-textarea-wrap"><code>wrap</code></dfn>
1.156 mike 897: attribute is an <a href="common-microsyntaxes.html#enumerated-attribute" id="enumerated-attribute-9">enumerated attribute</a> with two keywords
1.9 mike 898: and states: the <dfn id="attr-textarea-wrap-soft" title="attr-textarea-wrap-soft"><code>soft</code></dfn> keyword
1.198 mike 899: which maps to the <a href="#attr-textarea-wrap-soft-state" id="attr-textarea-wrap-soft-state-0" title="attr-textarea-wrap-soft-state">Soft</a> state, and the
1.9 mike 900: <dfn id="attr-textarea-wrap-hard" title="attr-textarea-wrap-hard"><code>hard</code></dfn> keyword
1.198 mike 901: which maps to the <a href="#attr-textarea-wrap-hard-state" id="attr-textarea-wrap-hard-state-0" title="attr-textarea-wrap-hard-state">Hard</a> state. The
902: <i>missing value default</i> is the <a href="#attr-textarea-wrap-soft-state" id="attr-textarea-wrap-soft-state-1" title="attr-textarea-wrap-soft-state">Soft</a> state.<p>The <dfn id="attr-textarea-wrap-soft-state" title="attr-textarea-wrap-soft-state">Soft</dfn> state
1.234 mike 903: indicates that the text in the <code><a href="#the-textarea-element" id="textarea-23">textarea</a></code> is not to be
1.198 mike 904: wrapped when it is submitted (though it can still be wrapped in the
905: rendering).<p>The <dfn id="attr-textarea-wrap-hard-state" title="attr-textarea-wrap-hard-state">Hard</dfn> state
1.234 mike 906: indicates that the text in the <code><a href="#the-textarea-element" id="textarea-24">textarea</a></code> is to have
1.198 mike 907: newlines added by the user agent so that the text is wrapped when it
908: is submitted.<p>If the element's <code title="attr-textarea-wrap"><a href="#attr-textarea-wrap" id="wrap-0">wrap</a></code>
909: attribute is in the <a href="#attr-textarea-wrap-hard-state" id="attr-textarea-wrap-hard-state-1" title="attr-textarea-wrap-hard-state">Hard</a> state, the <code title="attr-textarea-cols"><a href="#attr-textarea-cols" id="cols-1">cols</a></code> attribute must be
1.9 mike 910: specified.</p><!-- attr-textarea-wrap-off (attr-textarea-wrap-off-state): not
911: conforming; turns off the rendering of wrapping but otherwise acts
912: like 'soft' --><p>The <dfn id="attr-textarea-maxlength" title="attr-textarea-maxlength"><code>maxlength</code></dfn>
1.156 mike 913: attribute is a <a href="association-of-controls-and-forms.html#attr-fe-maxlength" id="attr-fe-maxlength-1" title="attr-fe-maxlength">form control <code title="">maxlength</code> attribute</a> controlled by the
1.234 mike 914: <code><a href="#the-textarea-element" id="textarea-25">textarea</a></code> element's <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#concept-textarea-dirty" title='Read about this "dirty value flag" reference in the full HTML5 spec.'>dirty value flag</a>.<p>If the <code><a href="#the-textarea-element" id="textarea-26">textarea</a></code> element has a <a href="association-of-controls-and-forms.html#maximum-allowed-value-length" id="maximum-allowed-value-length-2">maximum allowed
1.9 mike 915: value length</a>, then the element's children must be such that
1.162 mike 916: the <a class="full-spec-link" href="http://dev.w3.org/html5/spec/common-microsyntaxes.html#code-point-length" title='Read about this "code-point length" reference in the full HTML5 spec.'>code-point length</a> of the value of the element's
917: <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#textcontent" title='Read about this "textContent" reference in the full HTML5 spec.'>textContent</a></code> IDL attribute is equal to or less than the
1.160 mike 918: element's <a href="association-of-controls-and-forms.html#maximum-allowed-value-length" id="maximum-allowed-value-length-3">maximum allowed value length</a>.<p>The <dfn id="attr-textarea-required" title="attr-textarea-required"><code>required</code></dfn> attribute
1.156 mike 919: is a <a href="common-microsyntaxes.html#boolean-attribute" id="boolean-attribute-18">boolean attribute</a>. When specified, the user will
1.9 mike 920: be required to enter a value before submitting the form.</p><!-- similar text in the <input> section --><p>The <dfn id="attr-textarea-placeholder" title="attr-textarea-placeholder"><code>placeholder</code></dfn>
921: attribute represents a hint (a word or short phrase) intended to aid
922: the user with data entry. A hint could be a sample value or a brief
923: description of the expected format. The attribute, if specified,
924: must have a value that contains no U+000A LINE FEED (LF) or U+000D
1.160 mike 925: CARRIAGE RETURN (CR) characters.<p class="note">For a longer hint or other advisory text, the <code title="attr-title"><a href="elements.html#the-title-attribute" id="title-26">title</a></code> attribute is more appropriate.<p>The <code title="attr-textarea-placeholder"><a href="#attr-textarea-placeholder" id="placeholder-29">placeholder</a></code>
1.9 mike 926: attribute should not be used as an alternative to a
1.190 mike 927: <code><a href="forms.html#the-label-element" id="label-16">label</a></code>.<p>The <code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-55">form</a></code> attribute is used to
1.234 mike 928: explicitly associate the <code><a href="#the-textarea-element" id="textarea-27">textarea</a></code> element with its
1.156 mike 929: <a href="association-of-controls-and-forms.html#form-owner" id="form-owner-10">form owner</a>. The <code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name" id="name-42">name</a></code>
930: attribute represents the element's name. The <code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled" id="disabled-17">disabled</a></code> attribute is used to make
1.9 mike 931: the control non-interactive and to prevent its value from being
1.156 mike 932: submitted. The <code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus" id="autofocus-6">autofocus</a></code>
1.160 mike 933: attribute controls focus.<dl class="domintro"><dt><var title="">textarea</var> . <code title="attr-textarea-type">type</code></dt>
1.9 mike 934:
935: <dd>
936:
937: <p>Returns the string "<code title="">textarea</code>".</p>
938:
939: </dd>
940:
941: <dt><var title="">textarea</var> . <code title="attr-textarea-value">value</code></dt>
942:
943: <dd>
944:
945: <p>Returns the current value of the element.</p>
946:
947: <p>Can be set, to change the value.</p>
948:
949: </dd>
950:
951: </dl><div class="example">
952:
1.234 mike 953: <p>Here is an example of a <code><a href="#the-textarea-element" id="textarea-28">textarea</a></code> being used for
1.9 mike 954: unrestricted free-form text input in a form:</p>
955:
956: <pre><p>If you have any comments, please let us know: <textarea cols=80 name=comments></textarea></p></pre>
957:
1.202 mike 958: </div><h4 id="the-keygen-element"><span class="secno">4.10.14 </span>The <dfn><code>keygen</code></dfn> element</h4><dl class="element"><dt>Categories</dt>
1.203 mike 959: <dd><a href="content-models.html#flow-content" id="flow-content-126">Flow content</a>.</dd>
960: <dd><a href="content-models.html#phrasing-content" id="phrasing-content-137">Phrasing content</a>.</dd>
1.156 mike 961: <dd><a href="content-models.html#interactive-content" id="interactive-content-18">Interactive content</a>.</dd>
1.202 mike 962: <dd><a href="forms.html#category-listed" id="category-listed-8" title="category-listed">Listed</a>, <a href="forms.html#category-label" id="category-label-6" title="category-label">labelable</a>, <a href="forms.html#category-submit" id="category-submit-7" title="category-submit">submittable</a>, and <a href="forms.html#category-reset" id="category-reset-4" title="category-reset">resettable</a> <a href="forms.html#form-associated-element" id="form-associated-element-12">form-associated element</a>.</dd>
1.203 mike 963: <dt>Contexts in which this element can be used:</dt>
964: <dd>Where <a href="content-models.html#phrasing-content" id="phrasing-content-138">phrasing content</a> is expected.</dd>
1.9 mike 965: <dt>Content model:</dt>
966: <dd>Empty.</dd>
967: <dt>Content attributes:</dt>
1.156 mike 968: <dd><a href="elements.html#global-attributes" id="global-attributes-91">Global attributes</a></dd>
969: <dd><code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus" id="autofocus-7">autofocus</a></code></dd>
970: <dd><code title="attr-keygen-challenge"><a href="#attr-keygen-challenge" id="challenge">challenge</a></code></dd>
971: <dd><code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled" id="disabled-18">disabled</a></code></dd>
1.190 mike 972: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-56">form</a></code></dd>
1.156 mike 973: <dd><code title="attr-keygen-keytype"><a href="#attr-keygen-keytype" id="keytype">keytype</a></code></dd>
974: <dd><code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name" id="name-43">name</a></code></dd>
1.9 mike 975: <dt>DOM interface:</dt>
976: <dd>
1.156 mike 977: <pre class="idl">interface <dfn id="htmlkeygenelement">HTMLKeygenElement</dfn> : <a href="elements.html#htmlelement" id="htmlelement-102">HTMLElement</a> {
1.162 mike 978: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-autofocus" title='Read about this "autofocus" reference in the full HTML5 spec.'>autofocus</a>;
979: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-keygen-challenge" title='Read about this "challenge" reference in the full HTML5 spec.'>challenge</a>;
980: attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-disabled" title='Read about this "disabled" reference in the full HTML5 spec.'>disabled</a>;
981: readonly attribute <a href="forms.html#htmlformelement" id="htmlformelement-9">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
982: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-keygen-keytype" title='Read about this "keytype" reference in the full HTML5 spec.'>keytype</a>;
983: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-name" title='Read about this "name" reference in the full HTML5 spec.'>name</a>;
984:
985: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-keygen-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a>;
986:
987: readonly attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-willvalidate" title='Read about this "willValidate" reference in the full HTML5 spec.'>willValidate</a>;
988: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#validitystate" title='Read about this "ValidityState" reference in the full HTML5 spec.'>ValidityState</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validity" title='Read about this "validity" reference in the full HTML5 spec.'>validity</a>;
989: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validationmessage" title='Read about this "validationMessage" reference in the full HTML5 spec.'>validationMessage</a>;
990: boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-checkvalidatity" title='Read about this "checkValidity" reference in the full HTML5 spec.'>checkValidity</a>();
991: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-setcustomvalidity" title='Read about this "setCustomValidity" reference in the full HTML5 spec.'>setCustomValidity</a>(in DOMString error);
1.9 mike 992:
1.162 mike 993: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
1.9 mike 994: };</pre>
995: </dd>
1.190 mike 996: </dl><p>The <code><a href="#the-keygen-element" id="keygen-12">keygen</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a key
1.9 mike 997: pair generator control. When the control's form is submitted, the
998: private key is stored in the local keystore, and the public key is
1.160 mike 999: packaged and sent to the server.<p>The <dfn id="attr-keygen-challenge" title="attr-keygen-challenge"><code>challenge</code></dfn> attribute
1.9 mike 1000: may be specified. Its value will be packaged with the submitted
1.160 mike 1001: key.<p>The <dfn id="attr-keygen-keytype" title="attr-keygen-keytype"><code>keytype</code></dfn>
1.156 mike 1002: attribute is an <a href="common-microsyntaxes.html#enumerated-attribute" id="enumerated-attribute-10">enumerated attribute</a>. The following
1.160 mike 1003: table lists the keywords and states for the attribute — the
1.9 mike 1004: keywords in the left column map to the states listed in the cell in
1005: the second column on the same row as the keyword. User agents are
1.26 mike 1006: not required to support these values, and must only recognize values
1.160 mike 1007: whose corresponding algorithms they support.<table><thead><tr><th> Keyword <th> State
1008: <tbody><tr><td> <code title="">rsa</code>
1009: <td> <i title="">RSA</i>
1.9 mike 1010: <!-- v2 (see below)
1011: <tr>
1012: <td> <code title="">ec</code>
1013: <td> <i title="">EC</i>
1014: -->
1.160 mike 1015: </table><p>The <i>invalid value default</i> state is the <i title="">unknown</i> state. The <i>missing value default</i> state
1016: is the <i title="">RSA</i> state, if it is supported, or the <i title="">unknown</i> state otherwise.<p class="note">This specification does not specify what key types
1017: user agents are to support — it is possible for a user agent
1.190 mike 1018: to not support any key types at all.<p>The <code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-57">form</a></code> attribute is used to
1019: explicitly associate the <code><a href="#the-keygen-element" id="keygen-13">keygen</a></code> element with its
1.156 mike 1020: <a href="association-of-controls-and-forms.html#form-owner" id="form-owner-11">form owner</a>. The <code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name" id="name-44">name</a></code>
1021: attribute represents the element's name. The <code title="attr-fe-disabled"><a href="association-of-controls-and-forms.html#attr-fe-disabled" id="disabled-19">disabled</a></code> attribute is used to make
1.9 mike 1022: the control non-interactive and to prevent its value from being
1.156 mike 1023: submitted. The <code title="attr-fe-autofocus"><a href="association-of-controls-and-forms.html#attr-fe-autofocus" id="autofocus-8">autofocus</a></code>
1.160 mike 1024: attribute controls focus.<dl class="domintro"><dt><var title="">keygen</var> . <code title="attr-keygen-type">type</code></dt>
1.9 mike 1025:
1026: <dd>
1027:
1028: <p>Returns the string "<code title="">keygen</code>".</p>
1029:
1030: </dd>
1031:
1032: </dl><p class="note">This specification does not specify how the private
1033: key generated is to be used. It is expected that after receiving the
1.162 mike 1034: <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#signedpublickeyandchallenge" title='Read about this "SignedPublicKeyAndChallenge" reference in the full HTML5 spec.'>SignedPublicKeyAndChallenge</a></code> (SPKAC) structure, the
1.9 mike 1035: server will generate a client certificate and offer it back to the
1036: user for download; this certificate, once downloaded and stored in
1037: the key store along with the private key, can then be used to
1.88 mike 1038: authenticate to services that use TLS and certificate
1.9 mike 1039: authentication.</p><!-- how does the UA know which private key is associated with a
1040: certificate it gets back after the server has taken the public key
1041: created by <keygen> and turned it into a client cert? --><div class="example">
1042:
1043: <p>To generate a key pair, add the private key to the user's key
1044: store, and submit the public key to the server, markup such as the
1045: following can be used:</p>
1046:
1.22 mike 1047: <pre><form action="processkey.cgi" method="post" enctype="multipart/form-data">
1.9 mike 1048: <p><keygen name="key"></p>
1049: <p><input type=submit value="Submit key..."></p>
1050: </form></pre>
1051:
1052: <p>The server will then receive a form submission with a packaged
1053: RSA public key as the value of "<code title="">key</code>". This
1054: can then be used for various purposes, such as generating a client
1055: certificate, as mentioned above.</p>
1056:
1.202 mike 1057: </div><h4 id="the-output-element"><span class="secno">4.10.15 </span>The <dfn><code>output</code></dfn> element</h4><dl class="element"><dt>Categories</dt>
1.203 mike 1058: <dd><a href="content-models.html#flow-content" id="flow-content-127">Flow content</a>.</dd>
1059: <dd><a href="content-models.html#phrasing-content" id="phrasing-content-139">Phrasing content</a>.</dd>
1.202 mike 1060: <dd><a href="forms.html#category-listed" id="category-listed-9" title="category-listed">Listed</a>, <a href="forms.html#category-label" id="category-label-7" title="category-label">labelable</a>, and <a href="forms.html#category-reset" id="category-reset-5" title="category-reset">resettable</a> <a href="forms.html#form-associated-element" id="form-associated-element-13">form-associated element</a>.</dd>
1.203 mike 1061: <dt>Contexts in which this element can be used:</dt>
1062: <dd>Where <a href="content-models.html#phrasing-content" id="phrasing-content-140">phrasing content</a> is expected.</dd>
1.9 mike 1063: <dt>Content model:</dt>
1.203 mike 1064: <dd><a href="content-models.html#phrasing-content" id="phrasing-content-141">Phrasing content</a>.</dd>
1.9 mike 1065: <dt>Content attributes:</dt>
1.156 mike 1066: <dd><a href="elements.html#global-attributes" id="global-attributes-92">Global attributes</a></dd>
1067: <dd><code title="attr-output-for"><a href="#attr-output-for" id="for-2">for</a></code></dd>
1.190 mike 1068: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-58">form</a></code></dd>
1.156 mike 1069: <dd><code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name" id="name-45">name</a></code></dd>
1.9 mike 1070: <dt>DOM interface:</dt>
1071: <dd>
1.156 mike 1072: <pre class="idl">interface <dfn id="htmloutputelement">HTMLOutputElement</dfn> : <a href="elements.html#htmlelement" id="htmlelement-103">HTMLElement</a> {
1.167 mike 1073: [PutForwards=<a class="full-spec-link" href="http://dev.w3.org/html5/spec/common-dom-interfaces.html#dom-domsettabletokenlist-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>] readonly attribute <a href="urls.html#domsettabletokenlist" id="domsettabletokenlist-5">DOMSettableTokenList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-htmlfor" title='Read about this "htmlFor" reference in the full HTML5 spec.'>htmlFor</a>;
1.162 mike 1074: readonly attribute <a href="forms.html#htmlformelement" id="htmlformelement-10">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
1075: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fe-name" title='Read about this "name" reference in the full HTML5 spec.'>name</a>;
1076:
1077: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a>;
1078: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-defaultvalue" title='Read about this "defaultValue" reference in the full HTML5 spec.'>defaultValue</a>;
1079: attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
1080:
1081: readonly attribute boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-willvalidate" title='Read about this "willValidate" reference in the full HTML5 spec.'>willValidate</a>;
1082: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#validitystate" title='Read about this "ValidityState" reference in the full HTML5 spec.'>ValidityState</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validity" title='Read about this "validity" reference in the full HTML5 spec.'>validity</a>;
1083: readonly attribute DOMString <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-validationmessage" title='Read about this "validationMessage" reference in the full HTML5 spec.'>validationMessage</a>;
1084: boolean <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-checkvalidatity" title='Read about this "checkValidity" reference in the full HTML5 spec.'>checkValidity</a>();
1085: void <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-cva-setcustomvalidity" title='Read about this "setCustomValidity" reference in the full HTML5 spec.'>setCustomValidity</a>(in DOMString error);
1.11 mike 1086:
1.162 mike 1087: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
1.9 mike 1088: };</pre>
1089: </dd>
1.162 mike 1090: </dl><p>The <code><a href="#the-output-element" id="output-11">output</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> the result of a
1.160 mike 1091: calculation.<p>The <dfn id="attr-output-for" title="attr-output-for"><code>for</code></dfn> content
1.9 mike 1092: attribute allows an explicit relationship to be made between the
1093: result of a calculation and the elements that represent the values
1094: that went into the calculation or that otherwise influenced the
1.156 mike 1095: calculation. The <code title="attr-output-for"><a href="#attr-output-for" id="for-3">for</a></code> attribute,
1096: if specified, must contain a string consisting of an <a href="common-microsyntaxes.html#unordered-set-of-unique-space-separated-tokens" id="unordered-set-of-unique-space-separated-tokens-2">unordered
1.9 mike 1097: set of unique space-separated tokens</a>, each of which must have
1.201 mike 1098: the value of an <a href="elements.html#concept-id" id="concept-id-19" title="concept-id">ID</a> of an element in the same
1.190 mike 1099: <code><a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#document" title='Read about this "Document" reference in the full HTML5 spec.'>Document</a></code>.<p>The <code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-59">form</a></code> attribute is used to
1.156 mike 1100: explicitly associate the <code><a href="#the-output-element" id="output-12">output</a></code> element with its
1101: <a href="association-of-controls-and-forms.html#form-owner" id="form-owner-12">form owner</a>. The <code title="attr-fe-name"><a href="association-of-controls-and-forms.html#attr-fe-name" id="name-46">name</a></code>
1.162 mike 1102: attribute represents the element's name.<dl class="domintro"><dt><var title="">output</var> . <code title="dom-output-value"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a></code> [ = <var title="">value</var> ]</dt>
1.9 mike 1103:
1104: <dd>
1105:
1106: <p>Returns the element's current value.</p>
1107:
1108: <p>Can be set, to change the value.</p>
1109:
1110: </dd>
1111:
1.162 mike 1112: <dt><var title="">output</var> . <code title="dom-output-defaultValue"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-defaultvalue" title='Read about this "defaultValue" reference in the full HTML5 spec.'>defaultValue</a></code> [ = <var title="">value</var> ]</dt>
1.9 mike 1113:
1114: <dd>
1115:
1116: <p>Returns the element's current default value.</p>
1117:
1118: <p>Can be set, to change the default value.</p>
1119:
1120: </dd>
1121:
1.162 mike 1122: <dt><var title="">output</var> . <code title="dom-output-type"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-output-type" title='Read about this "type" reference in the full HTML5 spec.'>type</a></code></dt>
1.9 mike 1123:
1124: <dd>
1125:
1126: <p>Returns the string "<code title="">output</code>".</p>
1127:
1128: </dd>
1129:
1130: </dl><div class="example">
1131:
1.156 mike 1132: <p>A simple calculator could use <code><a href="#the-output-element" id="output-13">output</a></code> for its
1.9 mike 1133: display of calculated results:</p>
1134:
1135: <pre><form onsubmit="return false">
1136: <input name=a type=number step=any> +
1137: <input name=b type=number step=any> =
1.32 mike 1138: <output onforminput="value = a.valueAsNumber + b.valueAsNumber"></output>
1.9 mike 1139: </form></pre>
1140:
1.202 mike 1141: </div><h4 id="the-progress-element"><span class="secno">4.10.16 </span>The <dfn><code>progress</code></dfn> element</h4><p class="XXX annotation"><span><a href="http://www.w3.org/html/wg/tracker/issues/96">ISSUE-96</a> (progress) blocks progress to Last Call</span><dl class="element"><dt>Categories</dt>
1.203 mike 1142: <dd><a href="content-models.html#flow-content" id="flow-content-128">Flow content</a>.</dd>
1143: <dd><a href="content-models.html#phrasing-content" id="phrasing-content-142">Phrasing content</a>.</dd>
1.202 mike 1144: <dd><a href="forms.html#category-label" id="category-label-8" title="category-label">Labelable</a> <a href="forms.html#form-associated-element" id="form-associated-element-14">form-associated element</a>.</dd>
1.203 mike 1145: <dt>Contexts in which this element can be used:</dt>
1146: <dd>Where <a href="content-models.html#phrasing-content" id="phrasing-content-143">phrasing content</a> is expected.</dd>
1.11 mike 1147: <dt>Content model:</dt>
1.203 mike 1148: <dd><a href="content-models.html#phrasing-content" id="phrasing-content-144">Phrasing content</a>, but there must be no <code><a href="#the-progress-element" id="progress-8">progress</a></code> element descendants.</dd>
1.11 mike 1149: <dt>Content attributes:</dt>
1.156 mike 1150: <dd><a href="elements.html#global-attributes" id="global-attributes-93">Global attributes</a></dd>
1151: <dd><code title="attr-progress-value"><a href="#attr-progress-value" id="value-37">value</a></code></dd>
1152: <dd><code title="attr-progress-max"><a href="#attr-progress-max" id="max-36">max</a></code></dd>
1.190 mike 1153: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-60">form</a></code></dd>
1.11 mike 1154: <dt>DOM interface:</dt>
1155: <dd>
1.156 mike 1156: <pre class="idl">interface <dfn id="htmlprogresselement">HTMLProgressElement</dfn> : <a href="elements.html#htmlelement" id="htmlelement-104">HTMLElement</a> {
1.197 mike 1157: attribute double <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-progress-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
1158: attribute double <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-progress-max" title='Read about this "max" reference in the full HTML5 spec.'>max</a>;
1159: readonly attribute double <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-progress-position" title='Read about this "position" reference in the full HTML5 spec.'>position</a>;
1.162 mike 1160: readonly attribute <a href="forms.html#htmlformelement" id="htmlformelement-11">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
1161: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
1.11 mike 1162: };</pre>
1163: </dd>
1.162 mike 1164: </dl><p>The <code><a href="#the-progress-element" id="progress-9">progress</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> the
1.11 mike 1165: completion progress of a task. The progress is either indeterminate,
1166: indicating that progress is being made but that it is not clear how
1167: much more work remains to be done before the task is complete
1168: (e.g. because the task is waiting for a remote host to respond), or
1169: the progress is a number in the range zero to a maximum, giving the
1.160 mike 1170: fraction of work that has so far been completed.<p>There are two attributes that determine the current task
1171: completion represented by the element.<p>The <dfn id="attr-progress-value" title="attr-progress-value"><code>value</code></dfn>
1.11 mike 1172: attribute specifies how much of the task has been completed, and the
1173: <dfn id="attr-progress-max" title="attr-progress-max"><code>max</code></dfn> attribute
1174: specifies how much work the task requires in total. The units are
1.160 mike 1175: arbitrary and not specified.<p>Authors are encouraged to also include the current value and the
1.11 mike 1176: maximum value inline as text inside the element, so that the
1.160 mike 1177: progress is made available to users of legacy user agents.<div class="example">
1.11 mike 1178: <p>Here is a snippet of a Web application that shows the progress
1179: of some automated task:</p>
1180: <pre><section>
1181: <h2>Task Progress</h2>
1182: <p>Progress: <progress id="p" max=100><span>0</span>%</progress></p>
1183: <script>
1184: var progressBar = document.getElementById('p');
1185: function updateProgress(newValue) {
1186: progressBar.value = newValue;
1187: progressBar.getElementsByTagName('span')[0].textContent = newValue;
1188: }
1189: </script>
1190: </section></pre>
1191: <p>(The <code>updateProgress()</code> method in this example would
1192: be called by some other code on the page to update the actual
1193: progress bar as the task progressed.)</p>
1.156 mike 1194: </div><p>The <code title="attr-progress-value"><a href="#attr-progress-value" id="value-38">value</a></code> and <code title="attr-progress-max"><a href="#attr-progress-max" id="max-37">max</a></code> attributes, when present, must
1195: have values that are <a href="common-microsyntaxes.html#valid-floating-point-number" id="valid-floating-point-number-9" title="valid floating point number">valid
1196: floating point numbers</a>. The <code title="attr-progress-value"><a href="#attr-progress-value" id="value-39">value</a></code> attribute, if present, must
1.11 mike 1197: have a value equal to or greater than zero, and less than or equal
1.156 mike 1198: to the value of the <code title="attr-progress-max"><a href="#attr-progress-max" id="max-38">max</a></code>
1199: attribute, if present, or 1.0, otherwise. The <code title="attr-progress-max"><a href="#attr-progress-max" id="max-39">max</a></code> attribute, if present, must
1.160 mike 1200: have a value greater than zero.<p class="note">The <code><a href="#the-progress-element" id="progress-10">progress</a></code> element is the wrong
1.11 mike 1201: element to use for something that is just a gauge, as opposed to
1202: task progress. For instance, indicating disk space usage using
1.156 mike 1203: <code><a href="#the-progress-element" id="progress-11">progress</a></code> would be inappropriate. Instead, the
1.190 mike 1204: <code><a href="#the-meter-element" id="meter-8">meter</a></code> element is available for such use cases.<dl class="domintro"><dt><var title="">progress</var> . <code title="dom-progress-position"><a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-progress-position" title='Read about this "position" reference in the full HTML5 spec.'>position</a></code></dt>
1.11 mike 1205:
1206: <dd>
1207:
1208: <p>For a determinate progress bar (one with known current and
1209: maximum values), returns the result of dividing the current value
1210: by the maximum value.</p>
1211:
1.160 mike 1212: <p>For an indeterminate progress bar, returns −1.</p>
1.11 mike 1213:
1.202 mike 1214: </dl><h4 id="the-meter-element"><span class="secno">4.10.17 </span>The <dfn><code>meter</code></dfn> element</h4><p class="XXX annotation"><span><a href="http://www.w3.org/html/wg/tracker/issues/97">ISSUE-97</a> (meter) blocks progress to Last Call</span></p><!-- Keep this after <progress> and NOT close to <time> --><dl class="element"><dt>Categories</dt>
1.203 mike 1215: <dd><a href="content-models.html#flow-content" id="flow-content-129">Flow content</a>.</dd>
1216: <dd><a href="content-models.html#phrasing-content" id="phrasing-content-145">Phrasing content</a>.</dd>
1.202 mike 1217: <dd><a href="forms.html#category-label" id="category-label-9" title="category-label">Labelable</a> <a href="forms.html#form-associated-element" id="form-associated-element-15">form-associated element</a>.</dd>
1.203 mike 1218: <dt>Contexts in which this element can be used:</dt>
1219: <dd>Where <a href="content-models.html#phrasing-content" id="phrasing-content-146">phrasing content</a> is expected.</dd>
1.11 mike 1220: <dt>Content model:</dt>
1.203 mike 1221: <dd><a href="content-models.html#phrasing-content" id="phrasing-content-147">Phrasing content</a>, but there must be no <code><a href="#the-meter-element" id="meter-9">meter</a></code> element descendants.</dd>
1.11 mike 1222: <dt>Content attributes:</dt>
1.156 mike 1223: <dd><a href="elements.html#global-attributes" id="global-attributes-94">Global attributes</a></dd>
1224: <dd><code title="attr-meter-value"><a href="#attr-meter-value" id="value-41">value</a></code></dd>
1225: <dd><code title="attr-meter-min"><a href="#attr-meter-min" id="min-38">min</a></code></dd>
1226: <dd><code title="attr-meter-max"><a href="#attr-meter-max" id="max-41">max</a></code></dd>
1227: <dd><code title="attr-meter-low"><a href="#attr-meter-low" id="low">low</a></code></dd>
1228: <dd><code title="attr-meter-high"><a href="#attr-meter-high" id="high">high</a></code></dd>
1229: <dd><code title="attr-meter-optimum"><a href="#attr-meter-optimum" id="optimum">optimum</a></code></dd>
1.190 mike 1230: <dd><code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-61">form</a></code></dd>
1.11 mike 1231: <dt>DOM interface:</dt>
1232: <dd>
1.156 mike 1233: <pre class="idl">interface <dfn id="htmlmeterelement">HTMLMeterElement</dfn> : <a href="elements.html#htmlelement" id="htmlelement-105">HTMLElement</a> {
1.197 mike 1234: attribute double <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-meter-value" title='Read about this "value" reference in the full HTML5 spec.'>value</a>;
1235: attribute double <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-meter-min" title='Read about this "min" reference in the full HTML5 spec.'>min</a>;
1236: attribute double <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-meter-max" title='Read about this "max" reference in the full HTML5 spec.'>max</a>;
1237: attribute double <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-meter-low" title='Read about this "low" reference in the full HTML5 spec.'>low</a>;
1238: attribute double <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-meter-high" title='Read about this "high" reference in the full HTML5 spec.'>high</a>;
1239: attribute double <a class="full-spec-link" href="http://dev.w3.org/html5/spec/the-button-element.html#dom-meter-optimum" title='Read about this "optimum" reference in the full HTML5 spec.'>optimum</a>;
1.162 mike 1240: readonly attribute <a href="forms.html#htmlformelement" id="htmlformelement-12">HTMLFormElement</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/association-of-controls-and-forms.html#dom-fae-form" title='Read about this "form" reference in the full HTML5 spec.'>form</a>;
1241: readonly attribute <a class="full-spec-link" href="http://dev.w3.org/html5/spec/infrastructure.html#nodelist" title='Read about this "NodeList" reference in the full HTML5 spec.'>NodeList</a> <a class="full-spec-link" href="http://dev.w3.org/html5/spec/forms.html#dom-lfe-labels" title='Read about this "labels" reference in the full HTML5 spec.'>labels</a>;
1.11 mike 1242: };</pre>
1243: </dd>
1.190 mike 1244: </dl><p>The <code><a href="#the-meter-element" id="meter-10">meter</a></code> element <a class="full-spec-link" href="http://dev.w3.org/html5/spec/rendering.html#represents" title='Read about this "represents" reference in the full HTML5 spec.'>represents</a> a scalar
1.11 mike 1245: measurement within a known range, or a fractional value; for example
1246: disk usage, the relevance of a query result, or the fraction of a
1.190 mike 1247: voting population to have selected a particular candidate.<p>This is also known as a gauge.<p class="note">The <code><a href="#the-meter-element" id="meter-11">meter</a></code> element should not be used to
1.11 mike 1248: indicate progress (as in a progress bar). For that role, HTML
1.190 mike 1249: provides a separate <code><a href="#the-progress-element" id="progress-12">progress</a></code> element.<p class="note">The <code><a href="#the-meter-element" id="meter-12">meter</a></code> element also does not
1.160 mike 1250: represent a scalar value of arbitrary range — for example, it
1.11 mike 1251: would be wrong to use this to report a weight, or height, unless
1.160 mike 1252: there is a known maximum value.<p>There are six attributes that determine the semantics of the
1253: gauge represented by the element.<p>The <dfn id="attr-meter-min" title="attr-meter-min"><code>min</code></dfn> attribute
1.11 mike 1254: specifies the lower bound of the range, and the <dfn id="attr-meter-max" title="attr-meter-max"><code>max</code></dfn> attribute specifies
1255: the upper bound. The <dfn id="attr-meter-value" title="attr-meter-value"><code>value</code></dfn> attribute
1256: specifies the value to have the gauge indicate as the "measured"
1.160 mike 1257: value.<p>The other three attributes can be used to segment the gauge's
1.11 mike 1258: range into "low", "medium", and "high" parts, and to indicate which
1259: part of the gauge is the "optimum" part. The <dfn id="attr-meter-low" title="attr-meter-low"><code>low</code></dfn> attribute specifies
1260: the range that is considered to be the "low" part, and the <dfn id="attr-meter-high" title="attr-meter-high"><code>high</code></dfn> attribute specifies
1261: the range that is considered to be the "high" part. The <dfn id="attr-meter-optimum" title="attr-meter-optimum"><code>optimum</code></dfn> attribute
1262: gives the position that is "optimum"; if that is higher than the
1263: "high" value then this indicates that the higher the value, the
1264: better; if it's lower than the "low" mark then it indicates that
1265: lower values are better, and naturally if it is in between then it
1.160 mike 1266: indicates that neither high nor low values are good.<p> The <code title="attr-meter-value"><a href="#attr-meter-value" id="value-42">value</a></code> attribute must be
1.156 mike 1267: specified. The <code title="attr-meter-value"><a href="#attr-meter-value" id="value-43">value</a></code>, <code title="attr-meter-min"><a href="#attr-meter-min" id="min-39">min</a></code>, <code title="attr-meter-low"><a href="#attr-meter-low" id="low-0">low</a></code>, <code title="attr-meter-high"><a href="#attr-meter-high" id="high-0">high</a></code>, <code title="attr-meter-max"><a href="#attr-meter-max" id="max-42">max</a></code>, and <code title="attr-meter-optimum"><a href="#attr-meter-optimum" id="optimum-0">optimum</a></code> attributes, when present,
1268: must have values that are <a href="common-microsyntaxes.html#valid-floating-point-number" id="valid-floating-point-number-10" title="valid floating point
1.160 mike 1269: number">valid floating point numbers</a>.<p>In addition, the attributes' values are further constrained:<p>Let <var title="">value</var> be the <code title="attr-meter-value"><a href="#attr-meter-value" id="value-44">value</a></code> attribute's number.<p>If the <code title="attr-meter-min"><a href="#attr-meter-min" id="min-40">min</a></code> attribute
1.11 mike 1270: attribute is specified, then let <var title="">minimum</var> be that
1.160 mike 1271: attribute's value; otherwise, let it be zero.<p>If the <code title="attr-meter-max"><a href="#attr-meter-max" id="max-43">max</a></code> attribute
1.11 mike 1272: attribute is specified, then let <var title="">maximum</var> be that
1.160 mike 1273: attribute's value; otherwise, let it be 1.0.<p>The following inequalities must hold, as applicable:<ul class="brief"><li><var title="">minimum</var> ≤ <var title="">value</var> ≤ <var title="">maximum</var></li>
1274: <li><var title="">minimum</var> ≤ <code title="attr-meter-low"><a href="#attr-meter-low" id="low-1">low</a></code> ≤ <var title="">maximum</var> (if <code title="attr-meter-low"><a href="#attr-meter-low" id="low-2">low</a></code> is specified)</li>
1275: <li><var title="">minimum</var> ≤ <code title="attr-meter-high"><a href="#attr-meter-high" id="high-1">high</a></code> ≤ <var title="">maximum</var> (if <code title="attr-meter-high"><a href="#attr-meter-high" id="high-2">high</a></code> is specified)</li>
1276: <li><var title="">minimum</var> ≤ <code title="attr-meter-optimum"><a href="#attr-meter-optimum" id="optimum-1">optimum</a></code> ≤ <var title="">maximum</var> (if <code title="attr-meter-optimum"><a href="#attr-meter-optimum" id="optimum-2">optimum</a></code> is specified)</li>
1277: <li><code title="attr-meter-low"><a href="#attr-meter-low" id="low-3">low</a></code> ≤ <code title="attr-meter-high"><a href="#attr-meter-high" id="high-3">high</a></code> (if both <code title="attr-meter-low"><a href="#attr-meter-low" id="low-4">low</a></code> and <code title="attr-meter-high"><a href="#attr-meter-high" id="high-4">high</a></code> are specified)</li>
1.21 mike 1278: </ul><p class="note">If no minimum or maximum is specified, then the
1.11 mike 1279: range is assumed to be 0..1, and the value thus has to be within
1.160 mike 1280: that range.<p>Authors are encouraged to include a textual representation of the
1.11 mike 1281: gauge's state in the element's contents, for users of user agents
1.190 mike 1282: that do not support the <code><a href="#the-meter-element" id="meter-13">meter</a></code> element.<div class="example">
1.11 mike 1283:
1284: <p>The following examples show three gauges that would all be
1285: three-quarters full:</p>
1286:
1287: <pre>Storage space usage: <meter value=6 max=8>6 blocks used (out of 8 total)</meter>
1288: Voter turnout: <meter value=0.75><img alt="75%" src="graph75.png"></meter>
1289: Tickets sold: <meter min="0" max="100" value="75"></meter></pre>
1290:
1291: <p>The following example is incorrect use of the element, because
1292: it doesn't give a range (and since the default maximum is 1, both
1293: of the gauges would end up looking maxed out):</p>
1294:
1295: <pre class="bad"><p>The grapefruit pie had a radius of <meter value=12>12cm</meter>
1296: and a height of <meter value=2>2cm</meter>.</p> <!-- <strong>BAD!</strong> --></pre>
1297:
1298: <p>Instead, one would either not include the meter element, or use
1299: the meter element with a defined range to give the dimensions in
1300: context compared to other pies:</p>
1301:
1302: <pre><p>The grapefruit pie had a radius of 12cm and a height of
1303: 2cm.</p>
1304: <dl>
1305: <dt>Radius: <dd> <meter min=0 max=20 value=12>12cm</meter>
1306: <dt>Height: <dd> <meter min=0 max=10 value=2>2cm</meter>
1307: </dl></pre>
1308:
1309: </div><p>There is no explicit way to specify units in the
1.190 mike 1310: <code><a href="#the-meter-element" id="meter-14">meter</a></code> element, but the units may be specified in the
1.160 mike 1311: <code title="attr-title"><a href="elements.html#the-title-attribute" id="title-27">title</a></code> attribute in free-form text.<div class="example">
1.11 mike 1312:
1313: <p>The example above could be extended to mention the units:</p>
1314:
1315: <pre><dl>
1316: <dt>Radius: <dd> <meter min=0 max=20 value=12 title="centimeters">12cm</meter>
1317: <dt>Height: <dd> <meter min=0 max=10 value=2 title="centimeters">2cm</meter>
1318: </dl></pre>
1319:
1320: </div><div class="example">
1321: <p>The following markup:</p>
1322: <pre><h3>Suggested groups</h3>
1323: <menu type="toolbar">
1324: <a href="?cmd=hsg" onclick="hideSuggestedGroups()">Hide suggested groups</a>
1325: </menu>
1326: <ul>
1327: <li>
1328: <p><a href="/group/comp.infosystems.www.authoring.stylesheets/view">comp.infosystems.www.authoring.stylesheets</a> -
1329: <a href="/group/comp.infosystems.www.authoring.stylesheets/subscribe">join</a></p>
1330: <p>Group description: <strong>Layout/presentation on the WWW.</strong></p>
1331: <p><strong><meter value="0.5">Moderate activity,</meter></strong> Usenet, 618 subscribers</p>
1332: </li>
1333: <li>
1334: <p><a href="/group/netscape.public.mozilla.xpinstall/view">netscape.public.mozilla.xpinstall</a> -
1335: <a href="/group/netscape.public.mozilla.xpinstall/subscribe">join</a></p>
1336: <p>Group description: <strong>Mozilla XPInstall discussion.</strong></p>
1337: <p><strong><meter value="0.25">Low activity,</meter></strong> Usenet, 22 subscribers</p>
1338: </li>
1339: <li>
1340: <p><a href="/group/mozilla.dev.general/view">mozilla.dev.general</a> -
1341: <a href="/group/mozilla.dev.general/subscribe">join</a></p>
1342: <p><strong><meter value="0.25">Low activity,</meter></strong> Usenet, 66 subscribers</p>
1343: </li>
1344: </ul></pre>
1345: <p>Might be rendered as follows:</p>
1.203 mike 1346: <p><img alt="With the <meter> elements rendered as inline green bars of varying lengths." height="178" src="http://dev.w3.org/html5/spec/images/sample-meter.png" width="332"></p>
1.13 mike 1347: </div><p>User agents combine the value of
1.156 mike 1348: the <code title="attr-title"><a href="elements.html#the-title-attribute" id="title-28">title</a></code> attribute and the other
1.11 mike 1349: attributes to provide context-sensitive help or inline text
1.160 mike 1350: detailing the actual values.<div class="example">
1.11 mike 1351: <p>For example, the following snippet:</p>
1352: <pre><meter min=0 max=60 value=23.2 title=seconds></meter></pre>
1353: <p>...might cause the user agent to display a gauge with a tooltip
1354: saying "Value: 23.2 out of 60." on one line and "seconds" on a
1355: second line.</p>
1.190 mike 1356: </div><p>The <code title="attr-fae-form"><a href="association-of-controls-and-forms.html#attr-fae-form" id="form-62">form</a></code> attribute is used to
1357: explicitly associate the <code><a href="#the-meter-element" id="meter-15">meter</a></code> element with its
1.160 mike 1358: <a href="association-of-controls-and-forms.html#form-owner" id="form-owner-13">form owner</a>.<div class="example">
1.11 mike 1359:
1360: <p>The following example shows how a gauge could fall back to
1361: localized or pretty-printed text.</p>
1362:
1.160 mike 1363: <pre><p>Disk usage: <meter min=0 value=170261928 max=233257824>170 261 928 bytes used
1364: out of 233 257 824 bytes available</meter></p></pre>
1.11 mike 1365:
1.160 mike 1366: </div>
Webmaster
![[BACK]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/back.gif?vpn-1){kind=icon}
Return to the-button-element.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