Back to all docs
API Reference / Telerik.WinForms.Documents.FormatProviders.Html.Parsing.Dom / IDocument

Interface
IDocument

The 

Document
interface represents the entire HTML or XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data.

Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a 

Document
, the 
Document
interface also contains the factory methods needed to create these objects. The 
Node
objects created have a 
ownerDocument
attribute which associates them with the 
Document
within whose context they were created.

See also the Document Object Model (DOM) Level 2 Core Specification.

Definition

Properties

Doctype

The Document Type Declaration (see 

DocumentType
) associated with this document. For HTML documents as well as XML documents without a document type declaration this returns 
null
. The DOM Level 2 does not support editing the Document Type Declaration. 
docType
cannot be altered in any way, including through the use of methods inherited from the 
Node
interface, such as 
insertNode
or 
removeNode
.

Declaration

cs-api-definition
IDocumentType Doctype { get; }

Property Value

IDocumentType

DocumentElement

This is a convenience attribute that allows direct access to the child node that is the root element of the document. For HTML documents, this is the element with the tagName "HTML".

Declaration

cs-api-definition
IElement DocumentElement { get; }

Property Value

IElement

Implementation

The 

DOMImplementation
object that handles this document. A DOM application may use objects from multiple implementations.

Declaration

cs-api-definition
IDomImplementation Implementation { get; }

Property Value

IDomImplementation

Methods

CreateAttribute(string)

Creates an 

Attr
of the given name. Note that the 
Attr
instance can then be set on an 
Element
using the 
setAttributeNode
method.
To create an attribute with a qualified name and namespace URI, use the 
createAttributeNS
method.

Declaration

cs-api-definition
IAttr CreateAttribute(string name)

Parameters

name

string

The name of the attribute.

Returns

IAttr

A new 

Attr
object with the 
nodeName
attribute set to 
name
, and 
localName
, 
prefix
, and 
namespaceURI
set to 
null
. The value of the attribute is the empty string.

Exceptions

DomException

INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

CreateAttributeNS(string, string)

Creates an attribute of the given qualified name and namespace URI. HTML-only DOM implementations do not need to implement this method.

Declaration

cs-api-definition
IAttr CreateAttributeNS(string namespaceUri, string qualifiedName)

Parameters

namespaceUri

string

The namespace URI of the attribute to create.

qualifiedName

string

The qualified name of the attribute to instantiate.

Returns

IAttr

A new 

Attr
object with the following attributes: AttributeValue
Node.nodeName
qualifiedName 
Node.namespaceURI
namespaceURI

       <pre><code class="lang-csharp">Node.prefix</code></pre>prefix, extracted from 
       <pre><code class="lang-csharp">qualifiedName</code></pre>, or <pre><code class="lang-csharp">null</code></pre> if there is no 
       prefix<pre><code class="lang-csharp">Node.localName</code></pre>local name, extracted from 
       <pre><code class="lang-csharp">qualifiedName</code></pre><pre><code class="lang-csharp">Attr.name</code></pre>

       <pre><code class="lang-csharp">qualifiedName</code></pre><pre><code class="lang-csharp">Node.nodeValue</code></pre>the empty 
       string

Exceptions

DomException

INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
NAMESPACE_ERR: Raised if the 

qualifiedName
is malformed, if the 
qualifiedName
has a prefix and the

namespaceURI
is 
null
, if the 
qualifiedName
has a prefix that is "xml" and the 
namespaceURI
is different from "

http://www.w3.org/XML/1998/namespace", or if the

qualifiedName
is "xmlns" and the 
namespaceURI
is different from "

http://www.w3.org/2000/xmlns/".

CreateCdataSection(string)

Creates a 

CDATASection
node whose value is the specified string.

Declaration

cs-api-definition
ICdataSection CreateCdataSection(string data)

Parameters

data

string

The data for the 

CDATASection
contents.

Returns

ICdataSection

The new 

CDATASection
object.

Exceptions

DomException

NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

CreateComment(string)

Creates a 

Comment
node given the specified string.

Declaration

cs-api-definition
IComment CreateComment(string data)

Parameters

data

string

The data for the node.

Returns

IComment

The new 

Comment
object.

CreateDocumentFragment()

Creates an empty 

DocumentFragment
object.

Declaration

cs-api-definition
IDocumentFragment CreateDocumentFragment()

Returns

IDocumentFragment

A new 

DocumentFragment
.

CreateElement(string)

Creates an element of the type specified. Note that the instance returned implements the 

Element
interface, so attributes can be specified directly on the returned object.
In addition, if there are known attributes with default values, 
Attr
nodes representing them are automatically created and attached to the element.
To create an element with a qualified name and namespace URI, use the 
createElementNS
method.

Declaration

cs-api-definition
IElement CreateElement(string tagName)

Parameters

tagName

string

The name of the element type to instantiate. For XML, this is case-sensitive. For HTML, the 

tagName
parameter may be provided in any case, but it must be mapped to the canonical uppercase form by the DOM implementation.

Returns

IElement

A new 

Element
object with the 
nodeName
attribute set to 
tagName
, and 
localName
, 
prefix
, and 
namespaceURI
set to 
null
.

Exceptions

DomException

INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

CreateElementNS(string, string)

Creates an element of the given qualified name and namespace URI. HTML-only DOM implementations do not need to implement this method.

Declaration

cs-api-definition
IElement CreateElementNS(string namespaceUri, string qualifiedName)

Parameters

namespaceUri

string

The namespace URI of the element to create.

qualifiedName

string

The qualified name of the element type to instantiate.

Returns

IElement

A new 

Element
object with the following attributes:AttributeValue
Node.nodeName

       <pre><code class="lang-csharp">qualifiedName</code></pre><pre><code class="lang-csharp">Node.namespaceURI</code></pre>

       <pre><code class="lang-csharp">namespaceURI</code></pre><pre><code class="lang-csharp">Node.prefix</code></pre>prefix, extracted 
       from <pre><code class="lang-csharp">qualifiedName</code></pre>, or <pre><code class="lang-csharp">null</code></pre> if there is 
       no prefix<pre><code class="lang-csharp">Node.localName</code></pre>local name, extracted from 
       <pre><code class="lang-csharp">qualifiedName</code></pre><pre><code class="lang-csharp">Element.tagName</code></pre>

       <pre><code class="lang-csharp">qualifiedName</code></pre>

Exceptions

DomException

INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
NAMESPACE_ERR: Raised if the 

qualifiedName
is malformed, if the 
qualifiedName
has a prefix and the

namespaceURI
is 
null
, or if the 
qualifiedName
has a prefix that is "xml" and the 
namespaceURI
is different from "

http://www.w3.org/XML/1998/namespace" .

CreateEntityReference(string)

Creates an 

EntityReference
object. In addition, if the referenced entity is known, the child list of the 
EntityReference
node is made the same as that of the corresponding 
Entity
node.If any descendant of the 
Entity
node has an unbound namespace prefix, the corresponding descendant of the created 
EntityReference
node is also unbound; (its 
namespaceURI
is 
null
). The DOM Level 2 does not support any mechanism to resolve namespace prefixes.

Declaration

cs-api-definition
IEntityReference CreateEntityReference(string name)

Parameters

name

string

The name of the entity to reference.

Returns

IEntityReference

The new 

EntityReference
object.

Exceptions

DomException

INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

CreateProcessingInstruction(string, string)

Creates a 

ProcessingInstruction
node given the specified name and data strings.

Declaration

cs-api-definition
IProcessingInstruction CreateProcessingInstruction(string target, string data)

Parameters

target

string

The target part of the processing instruction.

data

string

The data for the node.

Returns

IProcessingInstruction

The new 

ProcessingInstruction
object.

Exceptions

DomException

INVALID_CHARACTER_ERR: Raised if the specified target contains an illegal character.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

CreateTextNode(string)

Creates a 

Text
node given the specified string.

Declaration

cs-api-definition
IText CreateTextNode(string data)

Parameters

data

string

The data for the node.

Returns

IText

The new 

Text
object.

GetElementById(string)

Returns the 

Element
whose 
ID
is given by 
elementId
. If no such element exists, returns 
null
. Behavior is not defined if more than one element has this 
ID
. The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return 
null
.

Declaration

cs-api-definition
IElement GetElementById(string elementId)

Parameters

elementId

string

The unique 

id
value for an element.

Returns

IElement

The matching element.

GetElementsByTagName(string)

Returns a 

NodeList
of all the 
Elements
with a given tag name in the order in which they are encountered in a preorder traversal of the 
Document
tree.

Declaration

cs-api-definition
INodeList GetElementsByTagName(string tagName)

Parameters

tagName

string

The name of the tag to match on. The special value "*" matches all tags.

Returns

INodeList

A new 

NodeList
object containing all the matched 
Elements
.

GetElementsByTagNameNS(string, string)

Returns a 

NodeList
of all the 
Elements
with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of the 
Document
tree.

Declaration

cs-api-definition
INodeList GetElementsByTagNameNS(string namespaceUri, string localName)

Parameters

namespaceUri

string

The namespace URI of the elements to match on. The special value "*" matches all namespaces.

localName

string

The local name of the elements to match on. The special value "*" matches all local names.

Returns

INodeList

A new 

NodeList
object containing all the matched 
Elements
.

ImportNode(INode, bool)

Imports a node from another document to this document. The returned node has no parent; (

parentNode
is 
null
). The source node is not altered or removed from the original document; this method creates a new copy of the source node.
For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node's 
nodeName
and 
nodeType
, plus the attributes related to namespaces (
prefix
, 
localName
, and 
namespaceURI
). As in the 
cloneNode
operation on a 
Node
, the source node is not altered.
Additional information is copied as appropriate to the 
nodeType
, attempting to mirror the behavior expected if a fragment of XML or HTML source was copied from one document to another, recognizing that the two documents may have different DTDs in the XML case. The following list describes the specifics for each type of node.
ATTRIBUTE_NODE
The 
ownerElement
attribute is set to 
null
and the 
specified
flag is set to 
true
on the generated 
Attr
. The descendants of the source 
Attr
are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Note that the 
deep
parameter has no effect on 
Attr
nodes; they always carry their children with them when imported.
DOCUMENT_FRAGMENT_NODE
If the 
deep
option was set to 
true
, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree. Otherwise, this simply generates an empty 
DocumentFragment
.
DOCUMENT_NODE
Document
nodes cannot be imported.
DOCUMENT_TYPE_NODE
DocumentType
nodes cannot be imported.
ELEMENT_NODE
Specified attribute nodes of the source element are imported, and the generated 
Attr
nodes are attached to the generated 
Element
. Default attributes are not copied, though if the document being imported into defines default attributes for this element name, those are assigned. If the 
importNode
deep
parameter was set to 
true
, the descendants of the source element are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
ENTITY_NODE
Entity
nodes can be imported, however in the current release of the DOM the 
DocumentType
is readonly. Ability to add these imported nodes to a 
DocumentType
will be considered for addition to a future release of the DOM.On import, the 
publicId
, 
systemId
, and 
notationName
attributes are copied. If a 
deep
import is requested, the descendants of the the source 
Entity
are recursively imported and the resulting nodes reassembled to form the corresponding subtree.
ENTITY_REFERENCE_NODE
Only the 
EntityReference
itself is copied, even if a 
deep
import is requested, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned.
NOTATION_NODE

       <pre><code class="lang-csharp">Notation</code></pre> nodes can be imported, however in the current 
       release of the DOM the <pre><code class="lang-csharp">DocumentType</code></pre> is readonly. Ability 
       to add these imported nodes to a <pre><code class="lang-csharp">DocumentType</code></pre> will be 
       considered for addition to a future release of the DOM.On import, the 
       <pre><code class="lang-csharp">publicId</code></pre> and <pre><code class="lang-csharp">systemId</code></pre> attributes are copied.
       Note that the <pre><code class="lang-csharp">deep</code></pre> parameter has no effect on 
       <pre><code class="lang-csharp">Notation</code></pre> nodes since they never have any children.</dd>
       <dt>
       PROCESSING_INSTRUCTION_NODE</dt>
       <dd>The imported node copies its 
       <pre><code class="lang-csharp">target</code></pre> and <pre><code class="lang-csharp">data</code></pre> values from those of the 
       source node.</dd>
       <dt>TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE</dt>
       <dd>These three 
       types of nodes inheriting from <pre><code class="lang-csharp">CharacterData</code></pre> copy their 
       <pre><code class="lang-csharp">data</code></pre> and <pre><code class="lang-csharp">length</code></pre> attributes from those of 
       the source node.</dd>
       </dl>

Declaration

cs-api-definition
INode ImportNode(INode importedNode, bool deep)

Parameters

importedNode

INode

The node to import.

deep

bool

If 

true
, recursively import the subtree under the specified node; if 
false
, import only the node itself, as explained above. This has no effect on 
Attr
, 
EntityReference
, and 
Notation
nodes.

Returns

INode

The imported node that belongs to this 

Document
.

Exceptions

DomException

NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.

In this article
DefinitionPropertiesDoctypeDocumentElementImplementationMethodsCreateAttribute(string)CreateAttributeNS(string, string)CreateCdataSection(string)CreateComment(string)CreateDocumentFragment()CreateElement(string)CreateElementNS(string, string)CreateEntityReference(string)CreateProcessingInstruction(string, string)CreateTextNode(string)GetElementById(string)GetElementsByTagName(string)GetElementsByTagNameNS(string, string)ImportNode(INode, bool)
Not finding the help you need?
Contact Support