Interface IDocument

Inherited Members
Namespace: Telerik.Windows.Documents.FormatProviders.Html.Parsing.Dom
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public interface IDocument : INode

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
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
IElement DocumentElement { get; }
Property Value
IElement

Implementation

The 

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

Declaration
IDomImplementation Implementation { get; }
Property Value
IDomImplementation

Methods

CreateAttribute(String)

Declaration
IAttr CreateAttribute(string name)
Parameters
System.String name

Returns
IAttr

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
IAttr CreateAttributeNS(string namespaceUri, string qualifiedName)
Parameters
System.String namespaceUri

System.String qualifiedName

Returns
IAttr

A new 

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

Node.namespaceURI
namespaceURI
Node.prefix
prefix, extracted from 
qualifiedName
, or 
null
if there is no

prefix

Node.localName
local name, extracted from 

qualifiedName
Attr.name
qualifiedName
Node.nodeValue
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
ICdataSection CreateCdataSection(string data)
Parameters
System.String data

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
IComment CreateComment(string data)
Parameters
System.String data

Returns
IComment

The new 

Comment
object.

CreateDocumentFragment()

Creates an empty 

DocumentFragment
object.

Declaration
IDocumentFragment CreateDocumentFragment()
Returns
IDocumentFragment

A new 

DocumentFragment
.

CreateElement(String)

Declaration
IElement CreateElement(string tagName)
Parameters
System.String tagName

Returns
IElement

CreateElementNS(String, String)

Declaration
IElement CreateElementNS(string namespaceUri, string qualifiedName)
Parameters
System.String namespaceUri

System.String qualifiedName

Returns
IElement

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
IEntityReference CreateEntityReference(string name)
Parameters
System.String name

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
IProcessingInstruction CreateProcessingInstruction(string target, string data)
Parameters
System.String target

System.String data

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
IText CreateTextNode(string data)
Parameters
System.String data

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
IElement GetElementById(string elementId)
Parameters
System.String elementId

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
INodeList GetElementsByTagName(string tagName)
Parameters
System.String tagName

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
INodeList GetElementsByTagNameNS(string namespaceUri, string localName)
Parameters
System.String namespaceUri

System.String localName

Returns
INodeList

A new 

NodeList
object containing all the matched 

Elements
.

ImportNode(INode, Boolean)

Declaration
INode ImportNode(INode importedNode, bool deep)
Parameters
INode importedNode

System.Boolean deep

Returns
INode

Extension Methods