sam-t2/devtools/amd64/html/python/lib/dom-document-objects.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="dom-element-objects.html" />
<link rel="prev" href="dom-documenttype-objects.html" />
<link rel="parent" href="node652.html" />
<link rel="next" href="dom-element-objects.html" />
<meta name='aesop' content='information' />
<title>13.6.2.5 Document Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="13.6.2.4 DocumentType Objects"
  href="dom-documenttype-objects.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="13.6.2 Objects in the"
  href="node652.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="13.6.2.6 Element Objects"
  href="dom-element-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="dom-documenttype-objects.html">13.6.2.4 DocumentType Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="node652.html">13.6.2 Objects in the</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="dom-element-objects.html">13.6.2.6 Element Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H3><A NAME="SECTION0015625000000000000000"></A><A NAME="dom-document-objects"></A>
<BR>
13.6.2.5 Document Objects
</H3>

<P>
A <tt class="class">Document</tt> represents an entire XML document, including its
constituent elements, attributes, processing instructions, comments
etc.  Remeber that it inherits properties from <tt class="class">Node</tt>.

<P>
<dl><dt><b><tt id='l2h-4393' xml:id='l2h-4393' class="member">documentElement</tt></b></dt>
<dd>
The one and only root element of the document.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4394' xml:id='l2h-4394' class="method">createElement</tt></b>(</nobr></td>
  <td><var>tagName</var>)</td></tr></table></dt>
<dd>
Create and return a new element node.  The element is not inserted
into the document when it is created.  You need to explicitly insert
it with one of the other methods such as <tt class="method">insertBefore()</tt> or
<tt class="method">appendChild()</tt>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4395' xml:id='l2h-4395' class="method">createElementNS</tt></b>(</nobr></td>
  <td><var>namespaceURI, tagName</var>)</td></tr></table></dt>
<dd>
Create and return a new element with a namespace.  The
<var>tagName</var> may have a prefix.  The element is not inserted into the
document when it is created.  You need to explicitly insert it with
one of the other methods such as <tt class="method">insertBefore()</tt> or
<tt class="method">appendChild()</tt>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4396' xml:id='l2h-4396' class="method">createTextNode</tt></b>(</nobr></td>
  <td><var>data</var>)</td></tr></table></dt>
<dd>
Create and return a text node containing the data passed as a
parameter.  As with the other creation methods, this one does not
insert the node into the tree.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4397' xml:id='l2h-4397' class="method">createComment</tt></b>(</nobr></td>
  <td><var>data</var>)</td></tr></table></dt>
<dd>
Create and return a comment node containing the data passed as a
parameter.  As with the other creation methods, this one does not
insert the node into the tree.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4398' xml:id='l2h-4398' class="method">createProcessingInstruction</tt></b>(</nobr></td>
  <td><var>target, data</var>)</td></tr></table></dt>
<dd>
Create and return a processing instruction node containing the
<var>target</var> and <var>data</var> passed as parameters.  As with the other
creation methods, this one does not insert the node into the tree.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4399' xml:id='l2h-4399' class="method">createAttribute</tt></b>(</nobr></td>
  <td><var>name</var>)</td></tr></table></dt>
<dd>
Create and return an attribute node.  This method does not associate
the attribute node with any particular element.  You must use
<tt class="method">setAttributeNode()</tt> on the appropriate <tt class="class">Element</tt> object
to use the newly created attribute instance.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4400' xml:id='l2h-4400' class="method">createAttributeNS</tt></b>(</nobr></td>
  <td><var>namespaceURI, qualifiedName</var>)</td></tr></table></dt>
<dd>
Create and return an attribute node with a namespace.  The
<var>tagName</var> may have a prefix.  This method does not associate the
attribute node with any particular element.  You must use
<tt class="method">setAttributeNode()</tt> on the appropriate <tt class="class">Element</tt> object
to use the newly created attribute instance.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4401' xml:id='l2h-4401' class="method">getElementsByTagName</tt></b>(</nobr></td>
  <td><var>tagName</var>)</td></tr></table></dt>
<dd>
Search for all descendants (direct children, children's children,
etc.) with a particular element type name.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4402' xml:id='l2h-4402' class="method">getElementsByTagNameNS</tt></b>(</nobr></td>
  <td><var>namespaceURI, localName</var>)</td></tr></table></dt>
<dd>
Search for all descendants (direct children, children's children,
etc.) with a particular namespace URI and localname.  The localname is
the part of the namespace after the prefix.
</dl>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="13.6.2.4 DocumentType Objects"
  href="dom-documenttype-objects.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="13.6.2 Objects in the"
  href="node652.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="13.6.2.6 Element Objects"
  href="dom-element-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="dom-documenttype-objects.html">13.6.2.4 DocumentType Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="node652.html">13.6.2 Objects in the</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="dom-element-objects.html">13.6.2.6 Element Objects</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>