Detailed Description

The interface for all XML-style documents.

Inheritance diagram for Dom.Document:

Public Member Functions
	Document ()

virtual void	LoadLanguageVariable (string groupName, string variableName, LanguageTextEvent onResolved)
	Loads a variable value from the language set. Note that this occurs after checking 'diverted' variables and after custom ones too - it only looks for languages. This is essentially handled by the document.languages API. More...

void	LoadHtml (string html, int mode)
	A simple loader which uses a HTML5 parser to load the given string. More...

void	LoadHtml (string html)
	A simple loader which uses a HTML5 parser to load the given string. More...

override bool	isEqualNode (Node other)
	Tests whether two nodes are the same by attribute comparison. More...

override string	ToString ()

TextNode	createTextNode ()
	Creates a text node. More...

Comment	createComment ()
	Creates a comment node. More...

Element	createElementNS (string namespaceName, string tag)
	Creates a new element in this document with the given namespace. You'll need to parent it to something. More...

Element	createElement (string tag)
	Creates a new element in this document. You'll need to parent it to something. E.g. with thisDocument.body.appendChild(...). Alternative to innerHTML and appendInnerHTML. More...

DocumentFragment	createDocumentFragment ()
	Creates a new document fragment in this document. More...

void	RemoveCachedElement (Element ele)
	Removes the given element from any attribute caches. You must check AttributesCached first. More...

void	IndexAttribute (string attrib)
	Request that the given attribute will be indexed. More...

void	StartAttributeIndex (string attrib)
	Starts indexing the given attribute right now. More...

Public Member Functions inherited from Dom.Node
HtmlElement	getByTagName (string tag)
	Casts getElementByTagName to a HtmlElement for you (exists because of SVG and MathML). More...

HtmlElement	getById (string id)
	Casts getElementById to a HtmlElement for you (exists because of SVG and MathML). More...

HtmlElement	getByAttribute (string property, string value)
	Casts getElementByAttribute to a HtmlElement for you (exists because of SVG and MathML). More...

bool	isBefore (Node other)
	True if this element is before the other one in the DOM. More...

void	insertAfter (Node toInsert, Node after)
	Inserts the given element after the given one. More...

Node	prependChild (Node child)
	Prepends the given element as a child. More...

Node	insertBefore (Node toInsert, Node before)
	Inserts the given element before the given one. More...

Node	replaceChild (Node with, Node element)
	Replaces the given child with another. More...

Node	appendChild (Node element)
	Adds the given element to the children of this element. More...

Node	moveChild (Node toMove, int index)
	Moves the given node to the given new index. More...

Node	removeChildAt (int index)
	Removes the child at the given index from this element. More...

Node	removeChild (Node element)
	Removes the given child from this element. More...

bool	hasChildNodes ()
	True if this element has any child nodes. More...

virtual bool	OnLexerAddNode (HtmlLexer lexer, int mode)
	Called when this node has been created and is being added to the given lexer. Closely related to Element.OnLexerCloseNode. More...

virtual Node	cloneNode (bool deep)
	Clones this node. More...

void	normalize ()
	Normalises this node. More...

bool	isSupported (string feature, string version)
	Is the given feature supported? More...

bool	hasAttributes ()
	Does this node have any attributes? More...

ushort	compareDocumentPosition (Node other)
	Compare document position (two elements only here). More...

bool	isParentOf (Node node)
	True if this is a parent of the given node. More...

bool	contains (Node node)
	True if the given node is a descendant of this or not. More...

string	lookupNamespaceURI (string nsUri)
	Looks up a namespace URI, returning the prefix. More...

HTMLCollection	getElementsByClassName (string className)
	Gets all elements with the given class name(s), seperated by spaces. May include this element or any of it's kids. More...

Element	getElementByTagNameNS (string namespaceURI, string tag)
	Gets the first child element with the given tag. More...

HTMLCollection	getElementsByTagNameNS (string namespaceURI, string tag)
	Gets all child elements with the given tag. More...

HTMLCollection	getElementsByTagNameNS (MLNamespace ns, string tag, bool stopWithOne)
	Gets all child elements with the given tag. More...

bool	getElementsByTagNameNS (MLNamespace ns, string tag, bool stopWithOne, INodeList results)
	Gets all child elements with the given tag. More...

Element	getElementByTagName (string tag)
	Gets the first child element with the given tag. More...

HTMLCollection	getElementsByTagName (string tag)
	Gets all child elements with the given tag. More...

HTMLCollection	getElementsByTagName (string tag, bool stopWithOne)
	Gets all child elements with the given tag. More...

bool	getElementsByTagName (string tag, bool stopWithOne, INodeList results)
	Gets all child elements with the given tag. More...

Element	getElementByName (string name)
	Gets the first child element with the given name. More...

HTMLCollection	getElementsByName (string name)
	Gets all child elements with the given name. More...

HTMLCollection	getElementsByName (string name, bool stopWithOne)
	Gets all child elements with the given name. More...

bool	getElementsByName (string name, bool stopWithOne, INodeList results)
	Gets all child elements with the given name. More...

Element	getElementById (string value)
	Gets a child element by ID. More...

NodeList	getElementsByAttribute (string property, string value)
	Gets all elements with the given attribute. May include this element or any of it's kids. More...

NodeList	getElementsWithProperty (string property, string value)
	Gets all elements with the given attribute. May include this element or any of it's kids. More...

void	getElementsByAttribute (string property, string value, INodeList results)
	Gets all elements with the given property. May include this element or any of it's kids. More...

void	getElementsByClassName (string[] classes, INodeList results)
	Gets all elements with the given class name(s). May include this element or any of it's kids. More...

Element	getElementByAttribute (string property, string value)
	Gets an element with the given attribute. May be this element or any of it's kids. More...

bool	isSameNode (Node other)
	Tests whether two nodes are the same, that is if they reference the same object More...

bool	isDefaultNamespace (string nsUri)
	Tests if this elements default namespace is the same as the given one. More...

string	lookupPrefix (string prefix)
	Looks up a namespace prefix, returning the namespace URI. More...

Node	remove ()
	Removes this node from the tree it belongs to. More...

virtual void	ToString (System.Text.StringBuilder result)

override string	ToString ()

Node	insertChild (int index, Node child)
	Inserts a child into this element at the given index. Pushes any elements at the given index over. More...

Node	replaceWith (Node element)
	Replaces this element with the given element. More...

virtual bool	OnAttributeChange (string attribute)
	Called on an instance of this handler when an attribute on the element it's attached to changes. It's also called when the tag is being loaded. More...

Public Member Functions inherited from Dom.EventTarget
void	ClearEvents ()
	Clears all events on this document. More...

bool	dispatchEvent (Event e)
	Runs an event of the given name. More...

void	addEventListener (string name, EventListener listener)
	Adds an event listener to this document. More...

void	addEventListener (string name, EventListener listener, bool useCapture)
	Adds an event listener to this document. More...

void	removeEventListener (string name, object evtHandlerInternal)
	Removes an event listener from this document. More...

void	addEventListener (string name, AnimationEventDelegate method)

void	addEventListener (string name, AudioProcessingEventDelegate method)

void	addEventListener (string name, BeforeInputEventDelegate method)

void	addEventListener (string name, BeforeUnloadEventDelegate method)

void	addEventListener (string name, BlobEventDelegate method)

void	addEventListener (string name, ClipboardEventDelegate method)

void	addEventListener (string name, CloseEventDelegate method)

void	addEventListener (string name, CompositionEventDelegate method)

void	addEventListener (string name, CustomEventDelegate method)

void	addEventListener (string name, CSSFontFaceLoadEventDelegate method)

void	addEventListener (string name, DeviceLightEventDelegate method)

void	addEventListener (string name, DeviceMotionEventDelegate method)

void	addEventListener (string name, DeviceOrientationEventDelegate method)

void	addEventListener (string name, DeviceProximityEventDelegate method)

void	addEventListener (string name, DomEventDelegate method)

void	addEventListener (string name, DOMTransactionEventDelegate method)

void	addEventListener (string name, DragEventDelegate method)

void	addEventListener (string name, EditingBeforeInputEventDelegate method)

void	addEventListener (string name, ErrorEventDelegate method)

void	addEventListener (string name, FetchEventDelegate method)

void	addEventListener (string name, FocusEventDelegate method)

void	addEventListener (string name, GamepadEventDelegate method)

void	addEventListener (string name, HashChangeEventDelegate method)

void	addEventListener (string name, IDBVersionChangeEventDelegate method)

void	addEventListener (string name, InputEventDelegate method)

void	addEventListener (string name, KeyboardEventDelegate method)

void	addEventListener (string name, MediaStreamEventDelegate method)

void	addEventListener (string name, MessageEventDelegate method)

void	addEventListener (string name, MouseEventDelegate method)

void	addEventListener (string name, MutationEventDelegate method)

void	addEventListener (string name, OfflineAudioCompletionEventDelegate method)

void	addEventListener (string name, PageTransitionEventDelegate method)

void	addEventListener (string name, PointerEventDelegate method)

void	addEventListener (string name, PopStateEventDelegate method)

void	addEventListener (string name, ProgressEventDelegate method)

void	addEventListener (string name, RelatedEventDelegate method)

void	addEventListener (string name, RTCDataChannelEventDelegate method)

void	addEventListener (string name, RTCIdentityErrorEventDelegate method)

void	addEventListener (string name, RTCIdentityEventDelegate method)

void	addEventListener (string name, RTCPeerConnectionIceEventDelegate method)

void	addEventListener (string name, SensorEventDelegate method)

void	addEventListener (string name, StorageEventDelegate method)

void	addEventListener (string name, TextEventDelegate method)

void	addEventListener (string name, TimeEventDelegate method)

void	addEventListener (string name, TouchEventDelegate method)

void	addEventListener (string name, TrackEventDelegate method)

void	addEventListener (string name, TransitionEventDelegate method)

void	addEventListener (string name, UIEventDelegate method)

void	addEventListener (string name, UserProximityEventDelegate method)

void	addEventListener (string name, WebGLContextEventDelegate method)

void	addEventListener (string name, WheelEventDelegate method)

void	addEventListener (string name, Nitro.DynamicMethod< Nitro.Void > listener)

void	addEventListener (string name, Nitro.DynamicMethod< Nitro.Void > listener, bool capture)

void	addEventListener (string name, ContextEventDelegate method)

void	addEventListener (string name, SlideEventDelegate method)

void	addEventListener (string name, PowerUI.SpriteEventDelegate method)

void	addEventListener (string name, SVGEventDelegate method)
	Adds an event listener to this document. More...

void	addEventListener (string name, SVGZoomEventDelegate method)

Public Attributes
DocumentType	doctype
	The document type of this document. More...

Dictionary< string, AttributeLookup >	AttributeIndex
	An attribute index, used to dramatically speed up frequently used unique attributes (like id). More...

Public Attributes inherited from Dom.Node
MLNamespace	Namespace
	The namespace this node belongs to. More...

Dictionary< string, string >	Properties =new Dictionary<string,string>()
	The set of attributes on this tag. An attribute is e.g. style="display:none;". More...

const ushort	ELEMENT_NODE =1

const ushort	ATTRIBUTE_NODE =2

const ushort	TEXT_NODE =3

const ushort	CDATA_SECTION_NODE =4

const ushort	ENTITY_REFERENCE_NODE =5

const ushort	ENTITY_NODE =6

const ushort	PROCESSING_INSTRUCTION_NODE =7

const ushort	COMMENT_NODE =8

const ushort	DOCUMENT_NODE =9

const ushort	DOCUMENT_TYPE_NODE =10

const ushort	DOCUMENT_FRAGMENT_NODE =11

const ushort	DOCUMENT_NOTATION_NODE =12

const ushort	DOCUMENT_POSITION_DISCONNECTED =1

const ushort	DOCUMENT_POSITION_PRECEDING =2

const ushort	DOCUMENT_POSITION_FOLLOWING =4

const ushort	DOCUMENT_POSITION_CONTAINS =8

const ushort	DOCUMENT_POSITION_CONTAINED_BY =16

const ushort	DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC =32

Public Attributes inherited from Dom.EventTarget
EventsSet	Events
	A set of events for this document. See addEventListener. More...

Static Public Attributes
static bool	AllowScripts =true
	Turn this off to block scripts. More...

Protected Member Functions
void	ReadyStateChange (int state)
	Changes the ready state of this document.</summrry> More...

void	ContentLoadedEvent ()
	Dispatches the DOMContentLoaded event. More...

Package Functions
virtual bool	ResourceStatus (EventTarget package, int status)
	Called when a resource for this document is loading. More...

virtual void	SetLocation (Location value, bool addHistory)
	Sets the current location, optionally adding a history entry or not. Generally you should use the window.history API or document.location instead. More...

Package Functions inherited from Dom.Node
void	empty ()
	Clears the child node set such that they no longer have a parent. More...

virtual void	ResetVariable (string name)
	Reloads the content of variables if it's name matches the given one. More...

virtual void	ResetAllVariables ()
	Re-resolves all variable tags. This is used when the language is changed. More...

virtual void	RemovedFromDOM ()
	Internal. Called when this element has been removed from the DOM. More...

virtual void	AddedToDOM ()
	Internal. Called when this element has been added to the DOM. More...

virtual void	ChangedDOM ()
	Called when this elements child nodes change. Doesn't occur when AddedToDOM or RemovedFromDOM trigger. More...

Package Attributes
int	resourcesLoading
	The number of resources still loading. When this reaches 0, onload is triggered. More...

Location	location_
	The current location of this document. Originates from the src attribute of iframes or is 'resources://' by default. More...

Location	basepath_
	The path that this document is relative to (if any). See basepath and baseURI. More...

Package Attributes inherited from Dom.Node
Document	document_
	The document that this node belongs to. More...

Node	parentNode_
	The parent node. More...

NodeList	childNodes_
	The kids of this node. This can be null. More...

Properties
DOMImplementation	implementation `[get]`

string	readyState `[get]`
	The current document ready state. More...

Location	location `[get, set]`
	The current location of this document. Originates from the src attribute of iframes or is 'resources://' by default. More...

Location	basepath `[get, set]`
	The path that this document is relative to (if any). Set to null to use document.location. More...

override string	baseURI `[get]`
	The path that this document is relative to (if any). More...

virtual Element	documentElement `[get]`
	The root document element. It must also subscribe to IRenderableNode. More...

override string	nodeName `[get]`
	The name for this type of node. More...

NodeIterator	allNodes `[get]`
	An iteratable set of all nodes from this document. Whilst iterating you can actively skip nodes, so it's often useful to cache this first. More...

virtual string	title `[get, set]`
	Document title. More...

virtual object	GlobalScope `[get]`
	The global scripting scope. More...

override ushort	nodeType `[get]`
	The type of element that this is. More...

virtual string	Target `[get]`
	The documents current target. It's the same as location.hash. More...

override Document	ownerDocument `[get]`
	The owning document. More...

virtual string	innerML `[get, set]`
	Gets or sets the inner markup of this document. More...

virtual EventTarget	windowTarget `[get]`
	A window event target if there is one. More...

bool	AttributesCached `[get]`
	True if more than one attribute is cached. More...

Properties inherited from Dom.Node
HtmlElement	htmlParentNode `[get]`
	The parent as a HtmlElement (convenience method). More...

HtmlDocument	htmlDocument `[get]`
	The ownerDocument as a Html document. More...

string	this[string property] `[get, set]`
	Gets or sets the named attribute of this tag. An attribute is e.g. style="display:none;". More...

virtual bool	ClearBackground `[get]`
	True if this node should clear the background state of the renderer. The background state essentially declares if this nodes background-color or background-image represents the viewports background. In HTML, both the body tag and root html tag can represent the background, so the root HTML node doesn't clear the state to allow body to set it if needed. So, only the root html element overrides this (and this is better than checking for .Tag=="html"). More...

override EventTarget	eventTargetParentNode `[get]`
	The parent node as used by EventTarget during capture. Can be null. More...

Document	document `[get]`
	The document that this node belongs to. More...

virtual string	nodeName `[get]`
	The name for this type of node. More...

virtual string	nodeValue `[get, set]`
	The value of this node. More...

virtual ushort	nodeType `[get]`
	The type of element that this is. More...

Node	firstChild `[get]`
	The first child of this element. More...

Node	lastChild `[get]`
	The last child of this element. More...

Node	previousSibling `[get]`
	The sibling before this one under this elements parent. Null if this is the first child. More...

Node	nextSibling `[get]`
	The sibling following this one under this elements parent. Null if this is the last child. More...

Element	previousElementSibling `[get]`
	The next non-text node sibling. More...

Element	nextElementSibling `[get]`
	The next non-text node sibling. More...

virtual Document	ownerDocument `[get]`
	The owner document. More...

virtual string	localName `[get]`
	The local name of this node. More...

virtual string	baseURI `[get]`
	The base URI. More...

string	namespaceURI `[get]`
	The namespace this node is in. More...

string	innerText `[get, set]`
	Gets or sets the text content of this element (i.e. the content without any html.). Setting this is good for preventing any html injection as it will be taken literally. More...

bool	isRooted `[get]`
	True if this element is in any document and is rooted. More...

string	outerText `[get, set]`
	Gets or sets the text content of this element (i.e. the content without any html.). Setting this is good for preventing any html injection as it will be taken literally. More...

virtual string	textContent `[get, set]`
	Gets or sets the text content of this element (i.e. the content without any html.). Setting this is good for preventing any html injection as it will be taken literally. More...

Element	parentElement `[get]`
	Gets the parent html element of this element. More...

string	prefix `[get]`
	The prefix (namespace). More...

Node	rootNode `[get]`
	The root node. More...

NodeList	childNodes `[get]`
	The set of children of this element. More...

HTMLCollection	children `[get]`
	The set of children elements. More...

int	sameNameIndex `[get]`
	Gets the index of this element in it's parents childNodes in terms of child elements that have the same name (tag) as this one. More...

int	childIndex `[get]`
	Gets the index of this element in it's parents childNodes. More...

int	childElementCount `[get]`
	The number of child elements of this element. More...

int	childCount `[get]`
	The number of children of this element. More...

Element	firstElementChild `[get]`
	The first non-text child of this element. More...

Element	lastElementChild `[get]`
	The last non-text child of this element. More...

string	id `[get, set]`
	The ID of this element. Won't ever be null. More...

string	className `[get, set]`
	The css class attribute of this element. Won't ever be null. Note that it can potentially hold multiple names, e.g. "red button". Use classList for those. More...

Node	parentNode `[get]`
	This nodes parent node. More...

DOMTokenList	classList `[get]`
	The set of class names. More...

Properties inherited from Dom.EventTarget
static DispatchStack	dispatchStackRef `[get]`
	The active dispatch stack. Use event.deepPath to access it (available during dispatch only). More...

virtual EventTarget	eventTargetParentNode `[get]`
	The parent node as used by EventTarget during capture. Can be null. More...

virtual NodeList	eventTargetChildren `[get]`
	The childNode set as used by EventTarget during capture. Can be null. More...

Properties inherited from Dom.IParentNode
NodeList	childNodes `[get]`
	The kids of this node. More...

Node	parentNode `[get]`
	The parent node. More...

Element	parentElement `[get]`
	The parent element. More...

int	childCount `[get]`
	The number of kids of this node. More...

int	childElementCount `[get]`
	The number of child elements of this parent. More...

HTMLCollection	children `[get]`
	The kids of this node. More...

Element	firstElementChild `[get]`
	The first element child of this node. More...

Element	lastElementChild `[get]`
	The last element child of this node. More...

Private Attributes
int	readyState_
	The current ready state. More...

Additional Inherited Members
Static Public Member Functions inherited from Dom.Node
static bool	PropertiesEqual (Dictionary< string, string > a, Dictionary< string, string > b)
	True if two args sets are equal. More...

Static Package Attributes inherited from Dom.EventTarget
static DispatchStack	PooledStack
	The current head of the pooled dispatched stacks. More...

Constructor & Destructor Documentation

Dom.Document.Document ( )

inline

Member Function Documentation

void Dom.Document.ContentLoadedEvent ( )

inlineprotected

Dispatches the DOMContentLoaded event.

Comment Dom.Document.createComment ( )

inline

Creates a comment node.

DocumentFragment Dom.Document.createDocumentFragment ( )

inline

Creates a new document fragment in this document.

Element Dom.Document.createElement ( string tag)

inline

Creates a new element in this document. You'll need to parent it to something. E.g. with thisDocument.body.appendChild(...). Alternative to innerHTML and appendInnerHTML.

Parameters

tag	The tag, e.g. <div id='myNewElement' .. >

Element Dom.Document.createElementNS	(	string	namespaceName,
		string	tag
	)

inline

Creates a new element in this document with the given namespace. You'll need to parent it to something.

TextNode Dom.Document.createTextNode ( )

inline

Creates a text node.

void Dom.Document.IndexAttribute ( string attrib)

inline

Request that the given attribute will be indexed.

override bool Dom.Document.isEqualNode ( Node other)

inlinevirtual

Tests whether two nodes are the same by attribute comparison.

Reimplemented from Dom.Node.

void Dom.Document.LoadHtml	(	string	html,
		int	mode
	)

inline

A simple loader which uses a HTML5 parser to load the given string.

Parameters

mode	The initial HtmlTreeMode to use.

void Dom.Document.LoadHtml ( string html)

inline

A simple loader which uses a HTML5 parser to load the given string.

virtual void Dom.Document.LoadLanguageVariable	(	string	groupName,
		string	variableName,
		LanguageTextEvent	onResolved
	)

inlinevirtual

Loads a variable value from the language set. Note that this occurs after checking 'diverted' variables and after custom ones too - it only looks for languages. This is essentially handled by the document.languages API.

Reimplemented in PowerUI.HtmlDocument.

void Dom.Document.ReadyStateChange ( int state)

inlineprotected

Changes the ready state of this document.</summrry>

void Dom.Document.RemoveCachedElement ( Element ele)

inline

Removes the given element from any attribute caches. You must check AttributesCached first.

virtual bool Dom.Document.ResourceStatus	(	EventTarget	package,
		int	status
	)

inlinepackagevirtual

Called when a resource for this document is loading.

Reimplemented in PowerUI.HtmlDocument.

virtual void Dom.Document.SetLocation	(	Location	value,
		bool	addHistory
	)

inlinepackagevirtual

Sets the current location, optionally adding a history entry or not. Generally you should use the window.history API or document.location instead.

Reimplemented in PowerUI.HtmlDocument.

void Dom.Document.StartAttributeIndex ( string attrib)

inline

Starts indexing the given attribute right now.

override string Dom.Document.ToString ( )

inline

Member Data Documentation

bool Dom.Document.AllowScripts =true

static

Turn this off to block scripts.

Dictionary<string,AttributeLookup> Dom.Document.AttributeIndex

An attribute index, used to dramatically speed up frequently used unique attributes (like id).

Location Dom.Document.basepath_

package

The path that this document is relative to (if any). See basepath and baseURI.

DocumentType Dom.Document.doctype

The document type of this document.

Location Dom.Document.location_

package

The current location of this document. Originates from the src attribute of iframes or is 'resources://' by default.

int Dom.Document.readyState_

private

The current ready state.

int Dom.Document.resourcesLoading

package

The number of resources still loading. When this reaches 0, onload is triggered.

Property Documentation

NodeIterator Dom.Document.allNodes

get

An iteratable set of all nodes from this document. Whilst iterating you can actively skip nodes, so it's often useful to cache this first.

bool Dom.Document.AttributesCached

get

True if more than one attribute is cached.

Location Dom.Document.basepath

getset

The path that this document is relative to (if any). Set to null to use document.location.

override string Dom.Document.baseURI

get

The path that this document is relative to (if any).

virtual Element Dom.Document.documentElement

get

The root document element. It must also subscribe to IRenderableNode.

virtual object Dom.Document.GlobalScope

get

The global scripting scope.

DOMImplementation Dom.Document.implementation

get

virtual string Dom.Document.innerML

getset

Gets or sets the inner markup of this document.

Location Dom.Document.location

getset

The current location of this document. Originates from the src attribute of iframes or is 'resources://' by default.

override string Dom.Document.nodeName

get

The name for this type of node.

override ushort Dom.Document.nodeType

get

The type of element that this is.

override Document Dom.Document.ownerDocument

get

The owning document.

string Dom.Document.readyState

get

The current document ready state.

virtual string Dom.Document.Target

get

The documents current target. It's the same as location.hash.

virtual string Dom.Document.title

getset

Document title.

virtual EventTarget Dom.Document.windowTarget

getpackage

A window event target if there is one.

Detailed Description

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Package Functions

Package Attributes

Properties

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation