1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
|
---
title: Document
slug: Web/API/Document
tags:
- API
- DOM
- Interface
- NeedsTranslation
- Reference
- TopicStub
translation_of: Web/API/Document
---
<div>{{APIRef}}</div>
<div> </div>
<p>The <strong><code>Document</code></strong> interface represents any web page loaded in the browser and serves as an entry point into the web page's content, which is the <a href="/en-US/docs/Using_the_W3C_DOM_Level_1_Core" title="Using_the_W3C_DOM_Level_1_Core">DOM tree</a>. The DOM tree includes elements such as {{HTMLElement("body")}} and {{HTMLElement("table")}}, among <a href="/en-US/docs/Web/HTML/Element">many others</a>. It provides functionality which is global to the document, such as obtaining the page's URL and creating new elements in the document.</p>
<p>{{inheritanceDiagram}}</p>
<p>The <code>Document</code> interface describes the common properties and methods for any kind of document. Depending on the document's type (e.g. <a href="/en-US/docs/HTML" title="HTML">HTML</a>, <a href="/en-US/docs/XML" title="XML">XML</a>, SVG, …), a larger API is available: HTML documents, served with the <code>text/html</code> content type, also implement the {{domxref("HTMLDocument")}} interface, wherease SVG documents implement the {{domxref("SVGDocument")}} interface.</p>
<h2 id="Properties" name="Properties">Properties</h2>
<p><em>This interface also inherits from the {{domxref("Node")}} and {{domxref("EventTarget")}} interfaces.</em></p>
<dl>
<dt>{{domxref("Document.all")}} {{Deprecated_inline}} {{non-standard_inline}}</dt>
<dd>Provides access to all elements with an <code>id</code>. This is a legacy, non-standard interface and you should use the {{domxref("document.getElementById()")}} method instead.</dd>
<dt>{{domxref("Document.async")}} {{Deprecated_inline}}</dt>
<dd>Used with {{domxref("Document.load")}} to indicate an asynchronous request.</dd>
<dt>{{domxref("Document.characterSet")}} {{readonlyinline}}</dt>
<dd>Returns the character set being used by the document.</dd>
<dt>{{domxref("Document.charset")}} {{readonlyinline}} {{Deprecated_inline}}</dt>
<dd>Alias of {{domxref("Document.characterSet")}}. Use this property instead.</dd>
<dt>{{domxref("Document.compatMode")}} {{readonlyinline}} {{experimental_inline}}</dt>
<dd>Indicates whether the document is rendered in <em>quirks</em> or <em>strict</em> mode.</dd>
<dt>{{domxref("Document.contentType")}} {{readonlyinline}} {{experimental_inline}}</dt>
<dd>Returns the Content-Type from the MIME Header of the current document.</dd>
<dt>{{domxref("Document.doctype")}} {{readonlyinline}}</dt>
<dd>Returns the Document Type Definition (DTD) of the current document.</dd>
<dt>{{domxref("Document.documentElement")}} {{readonlyinline}}</dt>
<dd>Returns the {{domxref("Element")}} that is a direct child of the document. For HTML documents, this is normally the HTML element.</dd>
<dt>{{domxref("Document.documentURI")}} {{readonlyinline}}</dt>
<dd>Returns the document location as a string.</dd>
<dt>{{domxref("Document.domConfig")}} {{Deprecated_inline}}</dt>
<dd>Should return a {{domxref("DOMConfiguration")}} object.</dd>
<dt>{{domxref("Document.fullscreen")}} {{obsolete_inline}}</dt>
<dd><code>true</code> when the document is in {{domxref("Using_full-screen_mode","full-screen mode")}}.</dd>
<dt>{{domxref("Document.hidden")}} {{readonlyinline}}</dt>
<dd>…</dd>
<dt>{{domxref("Document.implementation")}} {{readonlyinline}}</dt>
<dd>Returns the DOM implementation associated with the current document.</dd>
<dt>{{domxref("Document.inputEncoding")}} {{readonlyinline}} {{Deprecated_inline}}</dt>
<dd>Alias of {{domxref("Document.characterSet")}}. Use this property instead.</dd>
<dt>{{domxref("Document.lastStyleSheetSet")}} {{readonlyinline}}</dt>
<dd>Returns the name of the style sheet set that was last enabled. Has the value <code>null</code> until the style sheet is changed by setting the value of {{domxref("document.selectedStyleSheetSet","selectedStyleSheetSet")}}.</dd>
<dt>{{domxref("Document.mozSyntheticDocument")}} {{non-standard_inline}} {{gecko_minversion_inline("8.0")}}</dt>
<dd>Returns a {{jsxref("Boolean")}} that is <code>true</code> only if this document is synthetic, such as a standalone image, video, audio file, or the like.</dd>
<dt>{{domxref("Document.mozFullScreenElement")}} {{readonlyinline}} {{non-standard_inline}} {{gecko_minversion_inline("9.0")}}</dt>
<dd>The element that's currently in full screen mode for this document.</dd>
<dt>{{domxref("Document.mozFullScreenEnabled")}} {{readonlyinline}} {{non-standard_inline}} {{gecko_minversion_inline("9.0")}}</dt>
<dd><code>true</code> if calling {{domxref("Element.mozRequestFullscreen()")}} would succeed in the curent document.</dd>
<dt>{{domxref("Document.pointerLockElement")}} {{readonlyinline}} {{experimental_inline}}</dt>
<dd>Returns the element set as the target for mouse events while the pointer is locked. <code>null</code> if lock is pending, pointer is unlocked, or if the target is in another document.</dd>
<dt>{{domxref("Document.preferredStyleSheetSet")}} {{readonlyinline}}</dt>
<dd>Returns the preferred style sheet set as specified by the page author.</dd>
<dt>{{domxref("Document.scrollingElement")}} {{experimental_inline}} {{readonlyinline}}</dt>
<dd>Returns a reference to the {{domxref("Element")}} that scrolls the document.</dd>
<dt>{{domxref("Document.selectedStyleSheetSet")}}</dt>
<dd>Returns which style sheet set is currently in use.</dd>
<dt>{{domxref("Document.styleSheets")}} {{readonlyinline}}</dt>
<dd>Returns a list of the style sheet objects on the current document.</dd>
<dt>{{domxref("Document.styleSheetSets")}} {{readonlyinline}}</dt>
<dd>Returns a list of the style sheet sets available on the document.</dd>
<dt>{{domxref("Document.timeline")}} {{readonlyinline}}</dt>
<dd>…</dd>
<dt>{{domxref("Document.undoManager")}} {{readonlyinline}} {{experimental_inline}}</dt>
<dd>…</dd>
<dt>{{domxref("Document.URL")}} {{readonlyinline}}</dt>
<dd>Returns ...</dd>
<dt>{{domxref("Document.visibilityState")}} {{readonlyinline}}</dt>
<dd>…</dd>
<dt>{{domxref("Document.xmlEncoding")}} {{Deprecated_inline}}</dt>
<dd>Returns the encoding as determined by the XML declaration.</dd>
<dt>{{domxref("Document.xmlStandalone")}} {{obsolete_inline("10.0")}}</dt>
<dd>Returns <code>true</code> if the XML declaration specifies the document to be standalone (<em>e.g.,</em> An external part of the DTD affects the document's content), else <code>false</code>.</dd>
<dt>{{domxref("Document.xmlVersion")}} {{obsolete_inline("10.0")}}</dt>
<dd>Returns the version number as specified in the XML declaration or <code>"1.0"</code> if the declaration is absent.</dd>
</dl>
<p>The <code>Document</code> interface is extended with the {{domxref("ParentNode")}} interface:</p>
<p>{{page("/en-US/docs/Web/API/ParentNode","Properties")}}</p>
<h3 id="Extension_for_HTML_document">Extension for HTML document</h3>
<p><em>The <code>Document</code> interface for HTML documents inherits from the {{domxref("HTMLDocument")}} interface or, since HTML5, is extended for such documents.</em></p>
<dl>
<dt>{{domxref("Document.activeElement")}} {{readonlyinline}}</dt>
<dd>Returns the currently focused element.</dd>
<dt>{{domxref("Document.alinkColor")}} {{Deprecated_inline}}</dt>
<dd>Returns or sets the color of active links in the document body.</dd>
<dt>{{domxref("Document.anchors")}}</dt>
<dd>Returns a list of all of the anchors in the document.</dd>
<dt>{{domxref("Document.applets")}} {{Deprecated_inline}}</dt>
<dd>Returns an ordered list of the applets within a document.</dd>
<dt>{{domxref("Document.bgColor")}} {{Deprecated_inline}}</dt>
<dd>Gets/sets the background color of the current document.</dd>
<dt>{{domxref("Document.body")}}</dt>
<dd>Returns the {{HTMLElement("body")}} element of the current document.</dd>
<dt>{{domxref("Document.cookie")}}</dt>
<dd>Returns a semicolon-separated list of the cookies for that document or sets a single cookie.</dd>
<dt>{{domxref("Document.defaultView")}} {{readonlyinline}}</dt>
<dd>Returns a reference to the window object.</dd>
<dt>{{domxref("Document.designMode")}}</dt>
<dd>Gets/sets the ability to edit the whole document.</dd>
<dt>{{domxref("Document.dir")}} {{readonlyinline}}</dt>
<dd>Gets/sets directionality (rtl/ltr) of the document.</dd>
<dt>{{domxref("Document.domain")}} {{readonlyinline}}</dt>
<dd>Returns the domain of the current document.</dd>
<dt>{{domxref("Document.embeds")}} {{readonlyinline}}</dt>
<dd>Returns a list of the embedded {{HTMLElement('embed')}} elements within the current document.</dd>
<dt>{{domxref("document.fgColor")}} {{Deprecated_inline}}</dt>
<dd>Gets/sets the foreground color, or text color, of the current document.</dd>
<dt>{{domxref("Document.forms")}} {{readonlyinline}}</dt>
<dd>Returns a list of the {{HTMLElement("form")}} elements within the current document.</dd>
<dt>{{domxref("Document.head")}} {{readonlyinline}}</dt>
<dd>Returns the {{HTMLElement("head")}} element of the current document.</dd>
<dt>{{domxref("Document.height")}} {{non-standard_inline}} {{obsolete_inline}}</dt>
<dd>Gets/sets the height of the current document.</dd>
<dt>{{domxref("Document.images")}} {{readonlyinline}}</dt>
<dd>Returns a list of the images in the current document.</dd>
<dt>{{domxref("Document.lastModified")}} {{readonlyinline}}</dt>
<dd>Returns the date on which the document was last modified.</dd>
<dt>{{domxref("Document.linkColor")}} {{Deprecated_inline}}</dt>
<dd>Gets/sets the color of hyperlinks in the document.</dd>
<dt>{{domxref("Document.links")}} {{readonlyinline}}</dt>
<dd>Returns a list of all the hyperlinks in the document.</dd>
<dt>{{domxref("Document.location")}} {{readonlyinline}}</dt>
<dd>Returns the URI of the current document.</dd>
<dt>{{domxref("Document.plugins")}} {{readonlyinline}}</dt>
<dd>Returns a list of the available plugins.</dd>
<dt>{{domxref("Document.readyState")}} {{readonlyinline}} {{gecko_minversion_inline("1.9.2")}}</dt>
<dd>Returns loading status of the document.</dd>
<dt>{{domxref("Document.referrer")}} {{readonlyinline}}</dt>
<dd>Returns the URI of the page that linked to this page.</dd>
<dt>{{domxref("Document.scripts")}} {{readonlyinline}}</dt>
<dd>Returns all the {{HTMLElement("script")}} elements on the document.</dd>
<dt>{{domxref("Document.title")}}</dt>
<dd>Sets or gets title of the current document.</dd>
<dt>{{domxref("Document.URL")}} {{readonlyInline}}</dt>
<dd>Returns<span style="line-height: 19.0909080505371px;"> the document location as a string.</span></dd>
<dt>{{domxref("Document.vlinkColor")}} {{Deprecated_inline}}</dt>
<dd>Gets/sets the color of visited hyperlinks.</dd>
<dt>{{domxref("Document.width")}} {{non-standard_inline}} {{obsolete_inline}}</dt>
<dd>Returns the width of the current document.</dd>
</dl>
<h3 id="Event_handlers" name="Event_handlers">Event handlers</h3>
<dl>
<dt>{{domxref("GlobalEventHandlers.onabort")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("abort")}} event is raised.</dd>
<dt>{{domxref("Document.onafterscriptexecute")}} {{non-standard_inline}}</dt>
<dd>Represents the event handling code for the {{event("afterscriptexecute")}} event.</dd>
<dt>{{domxref("Document.onbeforescriptexecute")}} {{non-standard_inline}}</dt>
<dd>Represents the event handling code for the {{event("beforescriptexecute")}} event.</dd>
<dt>{{domxref("GlobalEventHandlers.onblur")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("blur")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.oncancel")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("cancel")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.oncanplay")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("canplay")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.oncanplaythrough")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("canplaythrough")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onchange")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("change")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onclick")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("click")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onclose")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("close")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.oncontextmenu")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("contextmenu")}} event is raised.</dd>
<dt>{{domxref("Document.oncopy")}} {{non-standard_inline}}</dt>
<dd>Represents the event handling code for the {{event("copy")}} event.</dd>
<dt>{{domxref("GlobalEventHandlers.oncuechange")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("cuechange")}} event is raised.</dd>
<dt>{{domxref("Document.oncut")}} {{non-standard_inline}}</dt>
<dd>Represents the event handling code for the {{event("cut")}} event.</dd>
<dt>{{domxref("GlobalEventHandlers.ondblclick")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("dblclick")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.ondrag")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("drag")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.ondragend")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("dragend")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.ondragenter")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("dragenter")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.ondragexit")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("dragexit")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.ondragleave")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("dragleave")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.ondragover")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("dragover")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.ondragstart")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("dragstart")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.ondrop")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("drop")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.ondurationchange")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("durationchange")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onemptied")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("emptied")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onended")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("ended")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onerror")}}</dt>
<dd>Is an {{domxref("OnErrorEventHandler")}} representing the code to be called when the {{event("error")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onfocus")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("focus")}} event is raised.</dd>
<dt>{{domxref("Document.onfullscreenchange")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("fullscreenchange")}} event is raised.</dd>
<dt>{{domxref("Document.onfullscreenerror")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("fullscreenerror")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.oninput")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("input")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.oninvalid")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("invalid")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onkeydown")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("keydown")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onkeypress")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("keypress")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onkeyup")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("keyup")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onload")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("load")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onloadeddata")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("loadeddata")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onloadedmetadata")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("loadedmetadata")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onloadstart")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("loadstart")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onmousedown")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("mousedown")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onmouseenter")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("mouseenter")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onmouseleave")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("mouseleave")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onmousemove")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("mousemove")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onmouseout")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("mouseout")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onmouseover")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("mouseover")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onmouseup")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("mouseup")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onmousewheel")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("mousewheel")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onpause")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("pause")}} event is raised.</dd>
<dt>{{domxref("Document.onpaste")}} {{non-standard_inline}}</dt>
<dd>Represents the event handling code for the {{event("paste")}} event.</dd>
<dt>{{domxref("GlobalEventHandlers.onplay")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("play")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onplaying")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("playing")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onpointerdown")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("pointerdown")}} event is raised.</dd>
<dt>{{domxref("Document.onpointerlockchange")}} {{experimental_inline}}</dt>
<dd>Represents the event handling code for the {{event("pointerlockchange")}} event.</dd>
<dt>{{domxref("Document.onpointerlockerror")}} {{experimental_inline}}</dt>
<dd>Represetnts the event handling code for the {{event("pointerlockerror")}} event.</dd>
<dt>{{domxref("GlobalEventHandlers.onpointermove")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("pointermove")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onpointerup")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("pointerup")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onpointercancel")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("pointercancel")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onpointerover")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("pointerover")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onpointerout")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("pointerout")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onpointerenter")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("pointerevent")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onpointerleave")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("pointerleave")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onpointerlockchange")}} {{experimental_inline}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("pointerlockchange")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onpointerlockerror")}} {{experimental_inline}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("pointerlockerror")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onprogress")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("progress")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onratechange")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("ratechange")}} event is raised.</dd>
<dt>{{domxref("Document.onreadystatechange")}} {{gecko_minversion_inline("1.9.2")}}</dt>
<dd>Represents the event handling code for the {{event("readystatechange")}} event.</dd>
<dt>{{domxref("GlobalEventHandlers.onreset")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("reset")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onscroll")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("scroll")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onseeked")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("seeked")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onseeking")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("seeking")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onselect")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("select")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onselectstart")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("selectstart")}} event is raised.</dd>
<dt>{{domxref("Document.onselectionchange")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("selectionchange")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onshow")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("show")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onsort")}} {{experimental_inline}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("sort")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onstalled")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("stalled")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onsubmit")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("submit")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onsuspend")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("suspend")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.ontimeupdate")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("timeupdate")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onvolumechange")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("volumechange")}} event is raised.</dd>
<dt>{{domxref("GlobalEventHandlers.onwaiting")}}</dt>
<dd>Is an {{domxref("EventHandler")}} representing the code to be called when the {{event("waiting")}} event is raised.</dd>
<dt>{{domxref("Document.onwheel")}} {{non-standard_inline}}</dt>
<dd>Represents the event handling code for the {{event("wheel")}} event.</dd>
</dl>
<h2 id="Methods" name="Methods">Methods</h2>
<p><em>This interface also inherits from the {{domxref("Node")}} and {{domxref("EventTarget")}} interfaces.</em></p>
<dl>
<dt>{{domxref("Document.adoptNode()")}}</dt>
<dd>Adopt node from an external document.</dd>
<dt>{{domxref("Document.captureEvents()")}} {{Deprecated_inline}}</dt>
<dd>See {{domxref("Window.captureEvents")}}.</dd>
<dt>{{domxref("Document.caretPositionFromPoint()")}}{{experimental_inline}}</dt>
<dd>Gets the {{domxref("CaretPosition")}} at or near the specified coordinates.</dd>
<dt>{{domxref("Document.caretRangeFromPoint()")}}{{non-standard_inline}}</dt>
<dd>Gets a {{Domxref("Range")}} object for the document fragment under the specified coordinates.</dd>
<dt>{{domxref("Document.createAttribute()")}}</dt>
<dd>Creates a new {{domxref("Attr")}} object and returns it.</dd>
<dt>{{domxref("Document.createAttributeNS()")}}</dt>
<dd>Creates a new attribute node in a given namespace and returns it.</dd>
<dt>{{domxref("Document.createCDATASection()")}}</dt>
<dd>Creates a new CDATA node and returns it.</dd>
<dt>{{domxref("Document.createComment()")}}</dt>
<dd>Creates a new comment node and returns it.</dd>
<dt>{{domxref("Document.createDocumentFragment()")}}</dt>
<dd>Creates a new document fragment.</dd>
<dt>{{domxref("Document.createElement()")}}</dt>
<dd>Creates a new element with the given tag name.</dd>
<dt>{{domxref("Document.createElementNS()")}}</dt>
<dd>Creates a new element with the given tag name and namespace URI.</dd>
<dt>{{domxref("Document.createEntityReference()")}} {{obsolete_inline}}</dt>
<dd>Creates a new entity reference object and returns it.</dd>
<dt>{{domxref("Document.createEvent()")}}</dt>
<dd>Creates an event object.</dd>
<dt>{{domxref("Document.createNodeIterator()")}}</dt>
<dd>Creates a {{domxref("NodeIterator")}} object.</dd>
<dt>{{domxref("Document.createProcessingInstruction()")}}</dt>
<dd>Creates a new {{domxref("ProcessingInstruction")}} object.</dd>
<dt>{{domxref("Document.createRange()")}}</dt>
<dd>Creates a {{domxref("Range")}} object.</dd>
<dt>{{domxref("Document.createTextNode()")}}</dt>
<dd>Creates a text node.</dd>
<dt>{{domxref("Document.createTouch()")}}</dt>
<dd>Creates a {{domxref("Touch")}} object.</dd>
<dt>{{domxref("Document.createTouchList()")}}</dt>
<dd>Creates a {{domxref("TouchList")}} object.</dd>
<dt>{{domxref("Document.createTreeWalker()")}}</dt>
<dd>Creates a {{domxref("TreeWalker")}} object.</dd>
<dt>{{domxref("Document.elementFromPoint()")}}{{experimental_inline}}</dt>
<dd>Returns the topmost element at the specified coordinates. </dd>
<dt>{{domxref("Document.elementsFromPoint()")}}{{experimental_inline}}</dt>
<dd>Returns an array of all elements at the specified coordinates.</dd>
<dt>{{domxref("Document.enableStyleSheetsForSet()")}}</dt>
<dd>Enables the style sheets for the specified style sheet set.</dd>
<dt>{{domxref("Document.exitPointerLock()")}} {{experimental_inline}}</dt>
<dd>Release the pointer lock.</dd>
<dt>{{domxref("Document.getAnimations()")}} {{experimental_inline}}</dt>
<dd>Returns an array of all {{domxref("Animation")}} objects currently in effect whose target elements are descendants of the <code>document</code>.</dd>
<dt>{{domxref("Document.getElementsByClassName()")}}</dt>
<dd>Returns a list of elements with the given class name.</dd>
<dt>{{domxref("Document.getElementsByTagName()")}}</dt>
<dd>Returns a list of elements with the given tag name.</dd>
<dt>{{domxref("Document.getElementsByTagNameNS()")}}</dt>
<dd>Returns a list of elements with the given tag name and namespace.</dd>
<dt>{{domxref("Document.importNode()")}}</dt>
<dd>Returns a clone of a node from an external document.</dd>
<dt>{{domxref("Document.normalizeDocument()")}} {{obsolete_inline}}</dt>
<dd>Replaces entities, normalizes text nodes, etc.</dd>
<dt>{{domxref("Document.registerElement()")}} {{experimental_inline}}</dt>
<dd>Registers a web component.</dd>
<dt>{{domxref("Document.releaseCapture()")}} {{non-standard_inline}} {{gecko_minversion_inline("2.0")}}</dt>
<dd>Releases the current mouse capture if it's on an element in this document.</dd>
<dt>{{domxref("Document.releaseEvents()")}} {{non-standard_inline}} {{Deprecated_inline}}</dt>
<dd>See {{domxref("Window.releaseEvents()")}}.</dd>
<dt>{{domxref("Document.routeEvent()")}} {{non-standard_inline}} {{obsolete_inline(24)}}</dt>
<dd>See {{domxref("Window.routeEvent()")}}.</dd>
<dt>{{domxref("Document.mozSetImageElement()")}} {{non-standard_inline}} {{gecko_minversion_inline("2.0")}}</dt>
<dd>Allows you to change the element being used as the background image for a specified element ID.</dd>
</dl>
<p>The <code>Document</code> interface is extended with the {{domxref("ParentNode")}} interface:</p>
<dl>
<dt>{{domxref("document.getElementById","document.getElementById(String id)")}}</dt>
<dd>Returns an object reference to the identified element.</dd>
<dt>{{domxref("document.querySelector","document.querySelector(String selector)")}} {{gecko_minversion_inline("1.9.1")}}</dt>
<dd>Returns the first Element node within the document, in document order, that matches the specified selectors.</dd>
<dt>{{domxref("document.querySelectorAll","document.querySelectorAll(String selector)")}} {{gecko_minversion_inline("1.9.1")}}</dt>
<dd>Returns a list of all the Element nodes within the document that match the specified selectors.</dd>
</dl>
<p>The <code>Document</code> interface is extended with the {{domxref("XPathEvaluator")}} interface:</p>
<dl>
<dt>{{domxref("document.createExpression","document.createExpression(String expression, XPathNSResolver resolver)")}}</dt>
<dd>Compiles an <code><a href="/en-US/docs/XPathExpression" title="XPathExpression">XPathExpression</a></code> which can then be used for (repeated) evaluations.</dd>
<dt>{{domxref("document.createNSResolver","document.createNSResolver(Node resolver)")}}</dt>
<dd>Creates an {{domxref("XPathNSResolver")}} object.</dd>
<dt>{{domxref("document.evaluate","document.evaluate(String expression, Node contextNode, XPathNSResolver resolver, Number type, Object result)")}}</dt>
<dd>Evaluates an XPath expression.</dd>
</dl>
<h3 id="Extension_for_HTML_documents">Extension for HTML documents</h3>
<p>The <code>Document</code> interface for HTML documents inherit from the {{domxref("HTMLDocument")}} interface or, since HTML5, is extended for such documents:</p>
<dl>
<dt>{{domxref("document.clear()")}} {{non-standard_inline}} {{Deprecated_inline}}</dt>
<dd>In majority of modern browsers, including recent versions of Firefox and Internet Explorer, this method does nothing.</dd>
<dt>{{domxref("document.close()")}}</dt>
<dd>Closes a document stream for writing.</dd>
<dt>{{domxref("document.execCommand","document.execCommand(String command[, Boolean showUI[, String value]])")}}</dt>
<dd>On an editable document, executes a formating command.</dd>
<dt>{{domxref("document.getElementsByName","document.getElementsByName(String name)")}}</dt>
<dd>Returns a list of elements with the given name.</dd>
<dt>{{domxref("document.getSelection()")}}</dt>
<dd>Returns a {{domxref("Selection")}} object related to text selected in the document.</dd>
<dt>{{domxref("document.hasFocus()")}}</dt>
<dd>Returns <code>true</code> if the focus is currently located anywhere inside the specified document.</dd>
<dt>{{domxref("document.open()")}}</dt>
<dd>Opens a document stream for writing.</dd>
<dt>{{domxref("document.queryCommandEnabled","document.queryCommandEnabled(String command)")}}</dt>
<dd>Returns true if the formating command can be executed on the current range.</dd>
<dt>{{domxref("document.queryCommandIndeterm","document.queryCommandIndeterm(String command)")}}</dt>
<dd>Returns true if the formating command is in an indeterminate state on the current range.</dd>
<dt>{{domxref("document.queryCommandState","document.queryCommandState(String command)")}}</dt>
<dd>Returns true if the formating command has been executed on the current range.</dd>
<dt>{{domxref("document.queryCommandSupported","document.queryCommandSupported(String command)")}}</dt>
<dd>Returns true if the formating command is supported on the current range.</dd>
<dt>{{domxref("document.queryCommandValue","document.queryCommandValue(String command)")}}</dt>
<dd>Returns the current value of the current range for a formating command.</dd>
<dt>{{domxref("document.write","document.write(String text)")}}</dt>
<dd>Writes text in a document.</dd>
<dt>{{domxref("document.writeln","document.writeln(String text)")}}</dt>
<dd>Writes a line of text in a document.</dd>
</dl>
<h2 id="Specifications">Specifications</h2>
<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
<tr>
<td>{{SpecName('Selection API', '', 'Extend Document and GlobalEventHandlers')}}</td>
<td>{{Spec2('Selection API')}}</td>
<td>Adds <code>onselectstart</code> and <code>onselectionchange</code>.</td>
</tr>
<tr>
<td>{{SpecName('DOM1','#i-Document','Document')}}</td>
<td>{{Spec2('DOM1')}}</td>
<td>Initial definition for the interface</td>
</tr>
<tr>
<td>{{SpecName('DOM2 Core','#i-Document','Document')}}</td>
<td>{{Spec2('DOM2 Core')}}</td>
<td>Supersede DOM 1</td>
</tr>
<tr>
<td>{{SpecName('DOM3 Core','#i-Document','Document')}}</td>
<td>{{Spec2('DOM3 Core')}}</td>
<td>Supersede DOM 2</td>
</tr>
<tr>
<td>{{SpecName('DOM WHATWG','#interface-document','Document')}}</td>
<td>{{Spec2('DOM WHATWG')}}</td>
<td>Intend to supersede DOM 3</td>
</tr>
<tr>
<td>{{SpecName('HTML WHATWG','dom.html#the-document-object','Document')}}</td>
<td>{{Spec2('HTML WHATWG')}}</td>
<td>Turn the {{domxref("HTMLDocument")}} interface into a <code>Document</code> extension.</td>
</tr>
<tr>
<td>{{SpecName('DOM3 XPath','xpath.html#XPathEvaluator','XPathEvaluator')}}</td>
<td>{{Spec2('DOM3 XPath')}}</td>
<td>Define the {{domxref("XPathEvaluator")}} interface which extend document.</td>
</tr>
<tr>
<td>{{SpecName('HTML Editing','#dom-document-getselection','Document')}}</td>
<td>{{Spec2('HTML Editing')}}</td>
<td>Extend the <code>Document</code> interface</td>
</tr>
<tr>
<td>{{SpecName('CSSOM View','#extensions-to-the-document-interface','Document')}}</td>
<td>{{Spec2('CSSOM View')}}</td>
<td>Extend the <code>Document</code> interface</td>
</tr>
<tr>
<td>{{SpecName('CSSOM','#extensions-to-the-document-interface','Document')}}</td>
<td>{{Spec2('CSSOM')}}</td>
<td>Extend the <code>Document</code> interface</td>
</tr>
<tr>
<td>{{SpecName('Pointer Lock','#extensions-to-the-document-interface','Document')}}</td>
<td>{{Spec2('Pointer Lock')}}</td>
<td>Extend the <code>Document</code> interface</td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility_notes">Browser compatibility notes</h2>
<h3 id="Firefox_notes">Firefox notes</h3>
<p>Mozilla defines a set of non-standard properties made only for XUL content:</p>
<dl>
<dt>{{domxref("document.currentScript")}} {{non-standard_inline}} {{gecko_minversion_inline("2.0")}}</dt>
<dd>Returns the {{HTMLElement("script")}} element that is currently executing.</dd>
<dt>{{domxref("document.documentURIObject")}} {{gecko_minversion_inline("1.9")}}</dt>
<dd>(<strong>Mozilla add-ons only!</strong>) Returns the {{Interface("nsIURI")}} object representing the URI of the document. This property only has special meaning in privileged JavaScript code (with UniversalXPConnect privileges).</dd>
<dt>{{domxref("document.popupNode")}}</dt>
<dd>Returns the node upon which a popup was invoked.</dd>
<dt>{{domxref("document.tooltipNode")}}</dt>
<dd>Returns the node which is the target of the current tooltip.</dd>
</dl>
<p>Mozilla also define some non-standard methods:</p>
<dl>
<dt>{{domxref("document.execCommandShowHelp")}} {{obsolete_inline("14.0")}}</dt>
<dd>This method never did anything and always threw an exception, so it was removed in Gecko 14.0 {{geckoRelease("14.0")}}.</dd>
<dt>{{domxref("document.getBoxObjectFor")}} {{obsolete_inline}}</dt>
<dd>Use the {{domxref("Element.getBoundingClientRect()")}} method instead.</dd>
<dt>{{domxref("document.loadOverlay")}} {{Fx_minversion_inline("1.5")}}</dt>
<dd>Loads a <a href="/en-US/docs/XUL_Overlays" title="XUL_Overlays">XUL overlay</a> dynamically. This only works in XUL documents.</dd>
<dt>{{domxref("document.queryCommandText")}} {{obsolete_inline("14.0")}}</dt>
<dd>This method never did anything but throw an exception, and was removed in Gecko 14.0 {{geckoRelease("14.0")}}.</dd>
</dl>
<h3 id="Internet_Explorer_notes">Internet Explorer notes</h3>
<p>Microsoft defines some non-standard properties:</p>
<dl>
<dt>{{domxref("document.fileSize")}}* {{non-standard_inline}} {{obsolete_inline}}</dt>
<dd>Returns size in bytes of the document. Starting with Internet Explorer 11, that property is no longer supported. See <a href="http://msdn.microsoft.com/en-us/library/ms533752%28v=VS.85%29.aspx" title="http://msdn.microsoft.com/en-us/library/ms533752%28v=VS.85%29.aspx">MSDN</a>.</dd>
<dt><span style="font-weight: normal; line-height: 1.5;">Internet Explorer does not support all methods from the <code>Node</code> interface in the <code>Document</code> interface:</span></dt>
</dl>
<dl>
<dt>{{domxref("document.contains")}}</dt>
<dd>As a work-around, <code>document.body.contains()</code> can be used.</dd>
</dl>
<p> </p>
|