# class HTMLDocument

###

Module | khtml
Namespace | DOM
Class | HTMLDocument
Inherits | DOM::Document

An HTMLDocument is the root of the HTML hierarchy and holds the entire content. Beside providing access to the hierarchy, it also provides some convenience methods for accessing certain sets of information from the document.

The following properties have been deprecated in favor of the corresponding ones for the BODY element:

- alinkColor

- background

- bgColor

- fgColor

- linkColor

- vlinkColor

### methods

- HTMLDocument ( )

  returns ctor

- HTMLDocument (parent)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  parent | KHTMLView |

  The parent is the widget the document should render itself in. Rendering information (like sizes, etc...) is only created if parent != 0

- HTMLDocument (other)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  other | DOM.HTMLDocument |

- HTMLDocument (other)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  other | DOM.Node |

- HTMLDocument (impl)

  returns ctor
  Not implemented

  Argument | Type | Default
  --- | --- | ---
  impl | HTMLDocumentImpl |

- URL ( )

  returns DOM.DOMString

  The absolute URI of the document.

- all ( )

  returns DOM.HTMLCollection

  Not part of the DOM

  A collection of all the IMG, OBJECT, AREA, A, forms and anchor elements of a document.

- anchors ( )

  returns DOM.HTMLCollection

  A collection of all the anchor ( A ) elements in a document with a value for the name attribute. Note. For reasons of backwards compatibility, the returned set of anchors only contains those anchors created with the name attribute, not those created with the id attribute.

- applets ( )

  returns DOM.HTMLCollection

  A collection of all the OBJECT elements that include applets and APPLET ( deprecated ) elements in a document.

- body ( )

  returns DOM.HTMLElement

  The element that contains the content for the document. In documents with BODY contents, returns the BODY element, and in frameset documents, this returns the outermost FRAMESET element.

- close ( )

  returns Nothing

  Closes a document stream opened by open() and forces rendering.

  Returns

- completeURL (url)

  returns DOM.DOMString

  Argument | Type | Default
  --- | --- | ---
  url | DOM.DOMString |

  not part of the DOM

  converts the given (potentially relative) URL in a full-qualified one, using the baseURL / document URL for the missing parts.

- cookie ( )

  returns DOM.DOMString

  The cookies associated with this document. If there are none, the value is an empty string. Otherwise, the value is a string: a semicolon-delimited list of "name, value" pairs for all the cookies associated with the page. For example, name=value;expires=date .

- domain ( )

  returns DOM.DOMString

  The domain name of the server that served the document, or a null string if the server cannot be identified by a domain name.

- forms ( )

  returns DOM.HTMLCollection

  A collection of all the forms of a document.

- getElementsByName (elementName)

  returns DOM.NodeList

  Argument | Type | Default
  --- | --- | ---
  elementName | DOM.DOMString |

  Returns the (possibly empty) collection of elements whose name value is given by elementName .

  elementName - The name attribute value for an element.

  Returns The matching elements.

- images ( )

  returns DOM.HTMLCollection

  A collection of all the IMG elements in a document. The behavior is limited to IMG elements for backwards compatibility.

- lastModified ( )

  returns DOM.DOMString

  Not part of the DOM

  The date the document was last modified.

- layers ( )

  returns DOM.HTMLCollection

  A collection of all the layers of a document.

- links ( )

  returns DOM.HTMLCollection

  A collection of all AREA elements and anchor ( A ) elements in a document with a value for the href attribute.

- open ( )

  returns Nothing

  Note. This method and the ones following allow a user to add to or replace the structure model of a document using strings of unparsed HTML. At the time of writing alternate methods for providing similar functionality for both HTML and XML documents were being considered. The following methods may be deprecated at some point in the future in favor of a more general-purpose mechanism.

  Open a document stream for writing. If a document exists in the target, this method clears it.

  Returns

- referrer ( )

  returns DOM.DOMString

  Returns the URI of the page that linked to this page. The value is an empty string if the user navigated to the page directly (not through a link, but, for example, via a bookmark).

- scripts ( )

  returns DOM.HTMLCollection

  A collection of all the scripts in the document.

- setBody (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | DOM.HTMLElement |

  see body

- setCookie (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | DOM.DOMString |

  see cookie

- setTitle (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | DOM.DOMString |

  see title

- title ( )

  returns DOM.DOMString

  The title of a document as specified by the TITLE element in the head of the document.

- write (text)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  text | DOM.DOMString |

  Write a string of text to a document stream opened by open() . The text is parsed into the document's structure model.

  text - The string to be parsed into some structure in the document structure model.

  Returns

- writeln (text)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  text | DOM.DOMString |

  Write a string of text followed by a newline character to a document stream opened by open() . The text is parsed into the document's structure model.

  text - The string to be parsed into some structure in the document structure model.

  Returns