Document

Baseline Widely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since julho de 2015.

* Some parts of this feature may have varying levels of support.

Para cada página carregada no browser, existe um objetoDocument. A interfaceDocument serve como um ponto de entrada para o conteúdo da Página ( a árvore DOM, incluindo elementos como<body> e<table>) e provê funcionalidades globais ao documento (como obter a URL da página e criar novos elementos no documento).

Um objeto document pode ser obtido por meio de várias APIs:

A mais comum; você trabalha com o script do documento que está rodando o script com o objeto document. (O mesmo document também pode ser referenciado comowindow.document.)
O documento de um iframe através da propriedadecontentDocument.
OresponseXML de um objetoXMLHttpRequest.
O documento ao qual um determinado node ou elemento pertence pode ser recuperado usando a propriedade do nodeownerDocument

Dependendo do tipo do documento (e.g.HTML ouXML), diferentes APIs estarão disponívels no objetoDocument.

Todo objetoDocument implementa a interfaceDocument (e consequentemente as interfacesNode eEventTarget). Portanto, as principais propriedades e métodos documentados nesta página estarão disponíveis para todos os tipos de documents.

Em navegadores mais atuais, alguns documentos (ex: aqueles que são servidos com o Content-Typetext/html) também implementam a interfaceHTMLDocument.
Em navegadores mais atuais, documentos SVG implementam a interfaceSVGDocument.

No futuro, todas essas interfaces irão ser divididas na interfaceDocument.

Propriedades

Nota:A interfaceDocument também herda das interfacesNode eEventTarget.

Document.allDeprecated Não padrão: Da acesso a todos os elementos do documento.È uma interface legada não padrão, voce deve usar o método Document.getElementById() como alternativa.
Document.asyncDeprecated: Usado como document.load que indica uma requisição asyncroma.
Document.characterSetExperimental: Retorna a codificação de caracteres que está sendo usado pelo documento.
Document.compatModeExperimental: indica se o documento é renderizado no modo Quirks ou Strict.
Document.contentTypeExperimental: Retorna o tipo de conteúdo do cabeçalho MIME do documento atual.
Document.doctype: Retorna o nome do tipo de conteudo do documento HTML.
Document.documentElement: Returns the Element that is a direct child of the document. For HTML documents, this is normally the HTML element.
Document.documentURI: Returns the document URL.
Document.domConfigDeprecated: Should return a DOMConfiguration object.
Document.implementation: Returns the DOM implementation associated with the current document.
Document.inputEncodingDeprecated: Returns the encoding used when the document was parsed.
Document.lastStyleSheetSet: Returns the name of the style sheet set that was last enabled. Has the valuenull until the style sheet is changed by setting the value ofselectedStyleSheetSet.
Document.mozSyntheticDocumentNão padrão: true if this document is synthetic, such as a standalone image, video, audio file, or the like.
Document.mozFullScreenNão padrão: true when the document is in full-screen mode.
Document.mozFullScreenElementNão padrão: The element that's currently in full screen mode for this document.
Document.mozFullScreenEnabledNão padrão: true if calling element.mozRequestFullscreen() would succeed in the curent document.
Document.pointerLockElementExperimental: Returns the element set as the target for mouse events while the pointer is locked.null if lock is pending, pointer is unlocked, or if the target is in another document.
Document.preferredStyleSheetSet: Returns the preferred style sheet set as specified by the page author.
Document.selectedStyleSheetSet: Returns which style sheet set is currently in use.
Document.styleSheets: Returns a list of the style sheet objects on the current document.
Document.styleSheetSets: Returns a list of the style sheet sets available on the document.
Document.xmlEncodingDeprecated: Returns the encoding as determined by the XML declaration.
Document.xmlStandalone: Returnstrue if the XML declaration specifies the document to be standalone (e.g., An external part of the DTD affects the document's content), elsefalse.
Document.xmlVersion: Returns the version number as specified in the XML declaration or"1.0" if the declaration is absent.

TheDocument interface is extended with theParentNode interface:

Extension for HTML documents

TheDocument interface for HTML documents inherit from theHTMLDocument interface or, since HTML5, is extended for such documents:

Document.activeElement: Returns the currently focused element.
Document.alinkColorDeprecated: Returns or sets the color of active links in the document body.
Document.anchors: Returns a list of all of the anchors in the document.
Document.appletsDeprecated: Returns an ordered list of the applets within a document.
Document.bgColorDeprecated: Gets/sets the background color of the current document.
Document.body: Returns the<body> element of the current document.
Document.cookie: Returns a semicolon-separated list of the cookies for that document or sets a single cookie.
Document.defaultView: Returns a reference to the window object.
Document.designMode: Gets/sets the ability to edit the whole document.
Document.dir: Gets/sets directionality (rtl/ltr) of the document.
Document.domain: Returns the domain of the current document.
Document.embeds: Returns a list of the embedded<embed> elements within the current document.
Document.fgColorDeprecated: Gets/sets the foreground color, or text color, of the current document.
Document.forms: Returns a list of the<form> elements within the current document.
Document.head: Returns the<head> element of the current document.
Document.heightNão padrão: Gets/sets the height of the current document.
Document.images: Returns a list of the images in the current document.
Document.lastModified: Returns the date on which the document was last modified.
Document.linkColorDeprecated: Gets/sets the color of hyperlinks in the document.
Document.links: Returns a list of all the hyperlinks in the document.
Document.location: Returns the URI of the current document.
Document.plugins: Returns a list of the available plugins.
Document.readyState: Returns loading status of the document.
Document.referrer: Returns the URI of the page that linked to this page.
Document.scripts: Returns all the<script> elements on the document.
Document.title: Returns the title of the current document.
Document.URL: Returns a string containing the URL of the current document.
Document.vlinkColorDeprecated: Gets/sets the color of visited hyperlinks.
Document.widthNão padrão: Returns the width of the current document.

Event handlers

Document.onpointerlockchangeExperimental: Returns the event handling code for the pointerlockchange event.
Document.onpointerlockerrorExperimental: Returns the event handling code for the pointerlockerror event.
Document.onreadystatechange: Returns the event handling code for thereadystatechange event.

Methods

Nota:TheDocument interface also inherits from theNode andEventTarget interfaces.

Document.adoptNode(Node node): Adopt node from an external document.
Document.captureEvents(String eventName)Deprecated: See window.captureEvents.
Document.caretPositionFromPoint(Number x, Number y): Gets aCaretPosition based on two coordinates.
Document.createAttribute(String name): Creates a newAttr object and returns it.
Document.createAttributeNS(String namespace, String name): Creates a new attribute node in a given namespace and returns it.
Document.createCDATASection(String data): Creates a new CDATA node and returns it.
Document.createComment(String comment): Creates a new comment node and returns it.
Document.createDocumentFragment(): Creates a new document fragment.
Document.createElement(String name): Creates a new element with the given tag name.
Document.createElementNS(String namespace, String name): Creates a new element with the given tag name and namespace URI.
Document.createEntityReference(String name): Creates a new entity reference object and returns it.
Document.createEvent(String interface): Creates an event object.
Document.createNodeIterator(Node root[, Number whatToShow[, NodeFilter filter]]): Creates aNodeIterator object.
Document.createProcessingInstruction(String target, String data): Creates a newProcessingInstruction object.
Document.createRange(): Creates aRange object.
Document.createTextNode(String text): Creates a text node.
Document.createTreeWalker(Node root[, Number whatToShow[, NodeFilter filter]]): Creates aTreeWalker object.
Document.elementFromPoint(Number x, Number y): Returns the element visible at the specified coordinates.
Document.enableStyleSheetsForSet(String name): Enables the style sheets for the specified style sheet set.
Document.exitPointerLock()Experimental: Release the pointer lock.
Document.getElementsByClassName(String className): Returns a list of elements with the given class name.
Document.getElementsByTagName(String tagName): Returns a list of elements with the given tag name.
Document.getElementsByTagNameNS(String namespace, String tagName): Returns a list of elements with the given tag name and namespace.
Document.importNode(Node node, Boolean deep): Returns a clone of a node from an external document.
document.mozSetImageElementNão padrão: Allows you to change the element being used as the background image for a specified element ID.
Document.normalizeDocument(): Replaces entities, normalizes text nodes, etc.
Document.releaseCapture()Não padrão: Releases the current mouse capture if it's on an element in this document.
Document.releaseEventsNão padrão Deprecated: See window.releaseEvents.
document.routeEventNão padrão: See window.routeEvent.

TheDocument interface is extended with theParentNode interface:

Document.getElementById(String id): Returns an object reference to the identified element.
Document.querySelector(String selector): Returns the first Element node within the document, in document order, that matches the specified selectors.
Document.querySelectorAll(String selector): Returns a list of all the Element nodes within the document that match the specified selectors.

TheDocument interface is extended with theXPathEvaluator interface:

Document.createExpression(String expression, XPathNSResolver resolver): Compiles anXPathExpression which can then be used for (repeated) evaluations.
Document.createNSResolver(Node resolver): Creates anXPathNSResolver object.
Document.evaluate(String expression, Node contextNode, XPathNSResolver resolver, Number type, Object result): Evaluates an XPath expression.

Extension for HTML documents

TheDocument interface for HTML documents inherit from theHTMLDocument interface or, since HTML5, is extended for such documents:

Document.clear()Não padrão Deprecated: In majority of modern browsers, including recent versions of Firefox and Internet Explorer, this method does nothing.
Document.close(): Closes a document stream for writing.
Document.execCommand(String command[, Boolean showUI[, String value]]): On an editable document, executes a formating command.
Document.getElementsByName(String name): Returns a list of elements with the given name.
Document.getSelection(): Returns aSelection object related to text selected in the document.
Document.hasFocus(): Returnstrue if the focus is currently located anywhere inside the specified document.
Document.open(): Opens a document stream for writing.
Document.queryCommandEnabled(String command): Returns true if the formating command can be executed on the current range.
Document.queryCommandIndeterm(String command): Returns true if the formating command is in an indeterminate state on the current range.
Document.queryCommandState(String command): Returns true if the formating command has been executed on the current range.
Document.queryCommandSupported(String command): Returns true if the formating command is supported on the current range.
Document.queryCommandValue(String command): Returns the current value of the current range for a formatting command.
Document.registerElement(String tagname[, Object options]): Registers a new custom element in the browser and returns a constructor for the new element.
Document.write(String text): Writes text in a document.
Document.writeln(String text): Writes a line of text in a document.

Specifications

Specification
DOM # interface-document
HTML # the-document-object
CSSOM View Module # extensions-to-the-document-interface
Pointer Lock 2.0 # extensions-to-the-document-interface
Selection API # extensions-to-document-interface

Compatibilidade com navegadores

Firefox notes

Mozilla defines a set of non-standard properties made only for XUL content:

document.currentScript: Returns the<script> element that is currently executing.
document.documentURIObject: (Mozilla add-ons only!) Returns thensIURI object representing the URI of the document. This property only has special meaning in privileged JavaScript code (with UniversalXPConnect privileges).
document.popupNode: Returns the node upon which a popup was invoked.
document.tooltipNode: Returns the node which is the target of the current tooltip.

Mozilla also define some non-standard methods:

Document.execCommandShowHelp: This method never did anything and always threw an exception, so it was removed in Gecko 14.0.
Document.getBoxObjectFor: Use theElement.getBoundingClientRect() method instead.
Document.loadOverlay: Loads aXUL overlay dynamically. This only works in XUL documents.
document.queryCommandText: This method never did anything but throw an exception, and was removed in Gecko 14.0.

Internet Explorer notes

Microsoft defines some non-standard properties:

document.fileSize*Não padrão: Returns size in bytes of the document. Starting with Internet Explorer 11, that property is no longer supported. See MSDN.Internet Explorer does not support all methods from theNode interface in theDocument interface
document.contains: As a work-around,document.body.contains() can be used.

Help improve MDN

Learn how to contribute

This page was last modified on17 de dez. de 2024 byMDN contributors.

View this page on GitHub •Report a problem with this content

Movatterモバイル変換

Document

Help improve MDN