SVGDocument Class
Contents
[
Hide
]SVGDocument class
An SVGDocument is the root of the SVG hierarchy and holds the entire content. Besides providing access to the hierarchy, it also provides some convenience methods for accessing certain sets of information from the document. When an ‘svg’ element is embedded inline as a component of a document from another package, such as when an ‘svg’ element is embedded inline within an XHTML document [XHTML], then an SVGDocument object will not exist; instead, the root object in the document object hierarchy will be a Document object of a different type, such as an HTMLDocument object. However, an SVGDocument object will indeed exist when the root element of the XML document hierarchy is an ‘svg’ element, such as when viewing a stand-alone SVG file(i.e., a file with MIME type “image/svg+xml”). In this case, the SVGDocument object will be the root object of the document object model hierarchy.
public class SVGDocument : Document, IDocumentCSS
Constructors
| Name | Description |
|---|---|
| SVGDocument() | Initializes a new instance of the SVGDocument class. |
| SVGDocument(Configuration) | Initializes a new instance of the SVGDocument class. |
| SVGDocument(RequestMessage) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. |
| SVGDocument(String) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. |
| SVGDocument(Url) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. |
| SVGDocument(RequestMessage, Configuration) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. |
| SVGDocument(Stream, String) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. Document loading starts from the current position in the stream. |
| SVGDocument(Stream, Url) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. Document loading starts from the current position in the stream. |
| SVGDocument(String, Configuration) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. |
| SVGDocument(String, String) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. |
| SVGDocument(String, Url) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. |
| SVGDocument(Url, Configuration) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. |
| SVGDocument(Stream, String, Configuration) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. Document loading starts from the current position in the stream. |
| SVGDocument(Stream, Url, Configuration) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. Document loading starts from the current position in the stream. |
| SVGDocument(String, String, Configuration) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. |
| SVGDocument(String, Url, Configuration) | Initializes a new instance of the SVGDocument class. Constructor works synchronously, it waits for loading of all the external resources (images, scripts, etc.). To load document asynchronously use method Navigate or its overloads. Or you can disable loading of some external resources by setting appropriate flags in Security. |
Properties
| Name | Description |
|---|---|
| getAttributes The attributes property returns a live collection of all attribute nodes registered to the specified node. Attributes is a key/value pair of Strings that represents any information regarding that attribute. | |
| getBaseURI The absolute base URI of this node or null if the implementation wasn’t able to obtain an absolute URI. | |
| getCharacterSet Gets the document’s encoding. | |
| getCharset Gets the document’s encoding. | |
| getChildElementCount Returns the current number of element nodes that are children of this element. 0 if this element has no child nodes that are of nodeType 1. | |
getChildNodes The read-only childNodes property of the Node interface returns a live NodeList of child nodes of the given element where the first child node is assigned index 0. Child nodes include elements, text and comments. | |
| getChildren Returns the child elements. | |
| getContentType Gets the document content type. | |
| getContext Gets the current browsing context. | |
| getDefaultView The defaultView IDL attribute of the Document interface, on getting, must return this Document’s browsing context’s WindowProxy object, if this Document has an associated browsing context, or null otherwise. | |
| getDoctype The Document Type Declaration associated with this document. | |
| getDocumentElement This is a convenience attribute that allows direct access to the child node that is the document element of the document. | |
| getDocumentURI The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument. | |
| getDomain The domain name of the server that served the document, or a null String if the server cannot be identified by a domain name. | |
getFirstChild The read-only firstChild property of the Node interface returns the node’s first child in the tree, or null if the node has no children. | |
| getFirstElementChild Returns the first child element node of this element. null if this element has no child elements. | |
| getImplementation The DOMImplementation object that handles this document. | |
| getInputEncoding Gets the document’s encoding. | |
getLastChild The read-only lastChild property of the Node interface returns the last child of the node. If its parent is an element, then the child is generally an element node, a text node, or a comment node. It returns null if there are no child elements | |
| getLastElementChild Returns the last child element node of this element. null if this element has no child elements. | |
getLocalName Returns the local part of the qualified name of this node. For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null. | |
| getLocation The location of the document. | |
| getNamespaceURI The Element.packageURI read-only property returns the package URI of the element, or null if the element is not in a package. | |
| getNextElementSibling Returns the next sibling element node of this element. null if this element has no element sibling nodes that come after this one in the document tree. | |
getNextSibling The read-only nextSibling property of the Node interface returns the node immediately following the specified one in their parent’s childNodes, or returns null if the specified node is the last child in the parent element. | |
| getNodeName The name of this node, depending on its type. | |
| getNodeType A code representing the type of the underlying object. | |
| [getNodeValue] | |
[setNodeValue] The nodeValue property of the Node interface returns or sets the value of the current node. | |
| getOrigin Gets the document origin. | |
| getOwnerDocument Gets the owner document. | |
getParentElement The read-only parentElement property of Node interface returns the DOM node’s parent Element, or null if the node either has no parent, or its parent isn’t a DOM Element. | |
| getParentNode The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree. | |
| [getPrefix] | |
| [setPrefix] The prefix read-only property returns the package prefix of the specified element, or null if no prefix is specified. | |
| getPreviousElementSibling Returns the previous sibling element node of this element. null if this element has no element sibling nodes that come before this one in the document tree. | |
getPreviousSibling The read-only previousSibling property of the Node interface returns the node immediately preceding the specified one in its parent’s childNodes list, or null if the specified node is the first in that list. | |
| getReadyState Returns the document readiness. The “loading” while the Document is loading, “interactive” once it is finished parsing but still loading sub-resources, and “complete” once it has loaded. | |
| getReferrer 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). | |
| getRootElement The root ‘svg’ in the document hierarchy. | |
| [getStrictErrorChecking] | |
| [setStrictErrorChecking] An attribute specifying whether error checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any DOMException on DOM operations or report errors while using Document.normalizeDocument(). In case of error, the behavior is undefined. This attribute is true by default. | |
| getStyleSheets A list containing all the style sheets explicitly linked into or embedded in a document. For HTML documents, this includes external style sheets, included via the HTML LINK element, and inline STYLE elements. | |
| [getTextContent] | |
[setTextContent] The textContent property of the Node interface represents the text content of the node and its descendants. | |
| getTitle The title of a document as specified by the ‘title’ sub-element of the ‘svg’ root element (i.e., Here is the title…) | |
| getURL The complete URI of the document. | |
| [getXmlStandalone] | |
| [setXmlStandalone] An attribute specifying, as part of the XML declaration, whether this document is standalone. This is false when unspecified. | |
| [getXmlVersion] | |
| [setXmlVersion] An attribute specifying, as part of the XML declaration, the version number of this document. If there is no declaration and if this document supports the “XML” feature, the value is “1.0”. If this document does not support the “XML” feature, the value is always null. |
Methods
| Name | Description |
|---|---|
| addEventListener(String, IEventListener) | The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. |
| addEventListener(String, DOMEventHandler, bool) | The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. |
| addEventListener(String, IEventListener, bool) | The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target. |
| appendChild(Node) | The appendChild() method of the Node interface adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, appendChild() moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node). |
| cloneNode() | The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not. |
| cloneNode(bool) | The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not. |
| createAttribute(String) | The Document.createAttribute() method creates a new attribute node, and returns it. The object created a node implementing the Attr interface. The DOM does not enforce what sort of attributes can be added to a particular element in this manner. |
| createAttributeNS(String, String) | The Document.createAttribute() method creates a new attribute node, and returns it. The object created a node implementing the Attr interface. The DOM does not enforce what sort of attributes can be added to a particular element in this manner. |
| createCDATASection(String) | Creates a CDATASection node whose value is the specified String. |
| createComment(String) | Creates a Comment node given the specified String. |
| createDocumentFragment() | Creates a new empty DocumentFragment into which DOM nodes can be added to build an offscreen DOM tree. |
| createDocumentType(String, String, String, String) | The method returns a DocumentType object which can either be used with DOMImplementation.createDocument upon document creation or can be put into the document via methods like Node.insertBefore() or Node.replaceChild(). |
| createElement(String) | In an HTML document, the document.createElement() method creates the HTML element specified by tagName, or an HTMLUnknownElement if tagName isn’t recognized. |
| createElementNS(String, String) | Creates an element of the given qualified name and package URI. |
| 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. |
| createEvent(String) | Creates an Event of a type supported by the implementation. |
| createExpression(String, IXPathNSResolver) | Creates a parsed XPath expression with resolved packages. This is useful when an expression will be reused in an application since it makes it possible to compile the expression String into a more efficient internal form and preresolve all package prefixes which occur within the expression. |
| createNodeIterator(Node) | Create a new NodeIterator over the subtree rooted at the specified node. |
| createNodeIterator(Node, long) | Create a new NodeIterator over the subtree rooted at the specified node. |
| createNodeIterator(Node, long, INodeFilter) | Create a new NodeIterator over the subtree rooted at the specified node. |
| createNSResolver(Node) | Adapts any DOM node to resolve packages so that an XPath expression can be easily evaluated relative to the context of the node where it appeared within the document. This adapter works like the DOM Level 3 method lookupNamespaceURI on nodes in resolving the packageURI from a given prefix using the current information available in the node’s hierarchy at the time lookupNamespaceURI is called, also correctly resolving the implicit xml prefix. |
| createProcessingInstruction(String, String) | Creates a ProcessingInstruction node given the specified name and data Strings. |
| createTextNode(String) | Creates a Text node given the specified String. |
| createTreeWalker(Node) | Create a new TreeWalker over the subtree rooted at the specified node. |
| createTreeWalker(Node, long) | Create a new TreeWalker over the subtree rooted at the specified node. |
| createTreeWalker(Node, long, INodeFilter) | Create a new TreeWalker over the subtree rooted at the specified node. |
| dispatchEvent(Event) | Dispatches an Event at the specified EventTarget, (synchronously) invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent(). |
| dispose() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| evaluate(String, Node, IXPathNSResolver, XPathResultType, object) | Evaluates an XPath expression String and returns a result of the specified type if possible. |
| getElementById(String) | The Document method getElementById() returns an Element object representing the element whose id property matches the specified String. Since element IDs are required to be unique if specified, they’re a useful way to get access to a specific element quickly. |
| getElementsByClassName(String) | The getElementsByClassName method of Document interface returns an array-like object of all child elements which have all of the given class name(s). |
| getElementsByTagName(String) | The getElementsByTagName method of Document interface returns an HTMLCollection of elements with the given tag name. |
| getElementsByTagNameNS(String, String) | Returns a list of elements with the given tag name belonging to the given package. The complete document is searched, including the root node. |
| getOverrideStyle(Element, String) | This method is used to retrieve the override style declaration for a specified element and a specified pseudo-element. |
| getPlatformType() | This method is used to retrieve the ECMAScript object . |
| hasAttributes() | The hasAttributes() method of the Element interface returns a boolean value indicating whether the current element has any attributes or not. |
| hasChildNodes() | The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not. |
| importNode(Node, bool) | Imports a node from another document to this document, without altering or removing the source node from the original document; this method creates a new copy of the source node. |
| insertBefore(Node, Node) | The insertBefore() method of the Node interface inserts a node before a reference node as a child of a specified parent node. |
| isDefaultNamespace(String) | The isDefaultNamespace() method of the Node interface accepts a package URI as an argument. It returns a boolean value that is true if the package is the default package on the given node and false if not. |
| isEqualNode(Node) | The isEqualNode() method of the Node interface tests whether two nodes are equal. Two nodes are equal when they have the same type, defining characteristics (for elements, this would be their ID, number of children, and so forth), its attributes match, and so on. The specific set of data points that must match varies depending on the types of the nodes. |
| isSameNode(Node) | The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object). |
| lookupNamespaceURI(String) | The lookupNamespaceURI() method of the Node interface takes a prefix as parameter and returns the package URI associated with it on the given node if found (and null if not). |
| lookupPrefix(String) | The lookupPrefix() method of the Node interface returns a String containing the prefix for a given package URI, if present, and null if not. When multiple prefixes are possible, the first prefix is returned. |
| navigate(RequestMessage) | Loads the document based on specified request object, replacing the previous content. |
| navigate(String) | Loads the document at the specified Uniform Resource Locator (URL) into the current instance, replacing the previous content. |
| navigate(Url) | Loads the document at the specified Uniform Resource Locator (URL) into the current instance, replacing the previous content. |
| navigate(Stream, String) | Loads the document from specified content and using baseUri to resolve relative resources, replacing the previous content. Document loading starts from the current position in the stream. |
| navigate(Stream, Url) | Loads the document from specified content and using baseUri to resolve relative resources, replacing the previous content. Document loading starts from the current position in the stream. |
| navigate(String, String) | Loads the document from specified content and using baseUri to resolve relative resources, replacing the previous content. |
| navigate(String, Url) | Loads the document from specified content and using baseUri to resolve relative resources, replacing the previous content. |
| normalize() | Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a “normal” form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter “normalize-characters” of the DOMConfiguration object attached to the Node.ownerDocument is true, this method will also fully normalize the characters of the Text nodes. |
| querySelector(String) | Returns the first Element in document, which match selector |
| querySelectorAll(String) | Returns a NodeList of all the Elements in document, which match selector |
| removeChild(Node) | The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node. |
| removeEventListener(String, IEventListener) | This method allows the removal of event listeners from the event target. If an is removed from an while it is processing an event, it will not be triggered by the current actions. Event Listeners can never be invoked after being removed. |
| removeEventListener(String, DOMEventHandler, bool) | This method allows the removal of event listeners from the event target. If an is removed from an while it is processing an event, it will not be triggered by the current actions. Event Listeners can never be invoked after being removed. |
| removeEventListener(String, IEventListener, bool) | This method allows the removal of event listeners from the event target. If an is removed from an while it is processing an event, it will not be triggered by the current actions. Event Listeners can never be invoked after being removed. |
| renderTo(IDevice) | This method is used to print the contents of the current document to the specified device. |
| replaceChild(Node, Node) | Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed. |
| save(IOutputStorage) | Saves the document content and resources to the output storage. |
| save(String) | Saves the document to local file specified by path. All resources used in this document will be saved in to adjacent folder, whose name will be constructed as: output_file_name + “_files”. |
| save(Url) | Saves the document to local file specified by url. All resources used in this document will be saved in to adjacent folder, whose name will be constructed as: output_file_name + “_files”. |
| save(IOutputStorage, SVGSaveFormat) | Saves the document content and resources to the output storage. |
| save(IOutputStorage, SVGSaveOptions) | Saves the document content and resources to the output storage. |
| save(String, SVGSaveFormat) | Saves the document to local file specified by path. All resources used in this document will be saved in to adjacent folder, whose name will be constructed as: output_file_name + “_files”. |
| save(String, SVGSaveOptions) | Saves the document to local file specified by path. All resources used in this document will be saved in to adjacent folder, whose name will be constructed as: output_file_name + “_files”. |
| save(Url, SVGSaveFormat) | Saves the document to local file specified by url. All resources used in this document will be saved in to adjacent folder, whose name will be constructed as: output_file_name + “_files”. |
| save(Url, SVGSaveOptions) | Saves the document to local file specified by url. All resources used in this document will be saved in to adjacent folder, whose name will be constructed as: output_file_name + “_files”. |
| toString() | Returns a String that represents this instance. |
| write(params String[]) | Write a String of text to a document stream opened by open(). Note that the function will produce a document which is not necessarily driven by a DTD and therefore might be produce an invalid result in the context of the document. |
| writeLn(params String[]) | Write a String of text followed by a newline character to a document stream opened by open(). Note that the function will produce a document which is not necessarily driven by a DTD and therefore might be produce an invalid result in the context of the document |
Events
| Name | Description |
|---|---|
| event OnAbort | Gets or sets event handler for OnAbort event. |
| event OnBlur | Gets or sets event handler for OnBlur event. |
| event OnCancel | Gets or sets event handler for OnCancel event. |
| event OnCanplay | Gets or sets event handler for OnCanplay event. |
| event OnCanPlayThrough | Gets or sets event handler for OnCanPlayThrough event. |
| event OnChange | Gets or sets event handler for OnChange event. |
| event OnClick | Gets or sets event handler for OnClick event. |
| event OnCueChange | Gets or sets event handler for OnCueChange event. |
| event OnDblClick | Gets or sets event handler for OnDblClick event. |
| event OnDurationChange | Gets or sets event handler for OnDurationChange event. |
| event OnEmptied | Gets or sets event handler for OnEmptied event. |
| event OnEnded | Gets or sets event handler for OnEnded event. |
| event OnError | Gets or sets event handler for OnError event. |
| event OnFocus | Gets or sets event handler for OnFocus event. |
| event OnInput | Gets or sets event handler for OnInput event. |
| event OnInvalid | Gets or sets event handler for OnInvalid event. |
| event OnKeyDown | Gets or sets event handler for OnKeyDown event. |
| event OnKeyPress | Gets or sets event handler for OnKeyPress event. |
| event OnKeyUp | Gets or sets event handler for OnKeyUp event. |
| event OnLoad | Gets or sets event handler for OnLoad event. |
| event OnLoadedData | Gets or sets event handler for OnLoadedData event. |
| event OnLoadedMetadata | Gets or sets event handler for OnLoadedMetadata event. |
| event OnLoadStart | Gets or sets event handler for OnLoadStart event. |
| event OnMouseDown | Gets or sets event handler for OnMouseDown event. |
| event OnMouseEnter | Gets or sets event handler for OnMouseEnter event. |
| event OnMouseLeave | Gets or sets event handler for OnMouseLeave event. |
| event OnMouseMove | Gets or sets event handler for OnMouseMove event. |
| event OnMouseOut | Gets or sets event handler for OnMouseOut event. |
| event OnMouseOver | Gets or sets event handler for OnMouseOver event. |
| event OnMouseUp | Gets or sets event handler for OnMouseUp event. |
| event OnMouseWheel | Gets or sets event handler for OnMouseWheel event. |
| event OnPause | Gets or sets event handler for OnPause event. |
| event OnPlay | Gets or sets event handler for OnPlay event. |
| event OnPlaying | Gets or sets event handler for OnPlaying event. |
| event OnProgress | Gets or sets event handler for OnProgress event. |
| event OnRateChange | Gets or sets event handler for OnRateChange event. |
| event OnReadyStateChange | Gets or sets event handler for OnReadyStateChange event. |
| event OnReset | Gets or sets event handler for OnReset event. |
| event OnResize | Gets or sets event handler for OnResize event. |
| event OnScroll | Gets or sets event handler for OnScroll event. |
| event OnSeeked | Gets or sets event handler for OnSeeked event. |
| event OnSeeking | Gets or sets event handler for OnSeeking event. |
| event OnSelect | Gets or sets event handler for OnSelect event. |
| event OnShow | Gets or sets event handler for OnShow event. |
| event OnStalled | Gets or sets event handler for OnStalled event. |
| event OnSubmit | Gets or sets event handler for OnSubmit event. |
| event OnSuspend | Gets or sets event handler for OnSuspend event. |
| event OnTimeUpdate | Gets or sets event handler for OnTimeUpdate event. |
| event OnToggle | Gets or sets event handler for OnToggle event. |
| event OnVolumeChange | Gets or sets event handler for OnVolumeChange event. |
| event OnWaiting | Gets or sets event handler for OnWaiting event. |
See Also
- class Document
- interface IDocumentEvent
- interface IDocumentCSS
- package com.aspose.html.Dom.Svg
- package Aspose.HTML
