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 namespace, 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 |
|---|---|
| override BaseURI { get; } | The absolute base URI of this node or null if the implementation wasn’t able to obtain an absolute URI. |
| CharacterSet { get; } | Gets the document’s encoding. |
| Charset { get; } | Gets the document’s encoding. |
| ChildElementCount { get; } | 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. |
| ChildNodes { get; } | A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.. |
| Children { get; } | Returns the child elements. |
| ContentType { get; } | Gets the document content type. |
| Context { get; } | Gets the current browsing context. |
| DefaultView { get; } | 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. |
| Doctype { get; } | The Document Type Declaration associated with this document. |
| DocumentElement { get; } | This is a convenience attribute that allows direct access to the child node that is the document element of the document. |
| DocumentURI { get; } | The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument. |
| Domain { get; } | The domain name of the server that served the document, or a null string if the server cannot be identified by a domain name. |
| FirstChild { get; } | The first child of this node. If there is no such node, this returns null. |
| FirstElementChild { get; } | Returns the first child element node of this element. null if this element has no child elements. |
| Implementation { get; } | The DOMImplementation object that handles this document. |
| InputEncoding { get; } | Gets the document’s encoding. |
| LastChild { get; } | The last child of this node. If there is no such node, this returns null. |
| LastElementChild { get; } | Returns the last child element node of this element. null if this element has no child elements. |
| virtual LocalName { get; } | 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. |
| Location { get; } | The location of the document. |
| virtual NamespaceURI { get; } | The namespace URI of this node, or null if it is unspecified. |
| NextElementSibling { get; } | 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. |
| NextSibling { get; } | The node immediately following this node. If there is no such node, this returns null. |
| override NodeName { get; } | The name of this node, depending on its type. |
| override NodeType { get; } | A code representing the type of the underlying object. |
| virtual NodeValue { get; set; } | The value of this node, depending on its type. |
| Origin { get; } | Gets the document origin. |
| override OwnerDocument { get; } | Gets the owner document. |
| ParentElement { get; } | Gets the parent Element of this node. |
| ParentNode { get; } | The parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is null. |
| virtual Prefix { get; set; } | The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect |
| PreviousElementSibling { get; } | 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. |
| PreviousSibling { get; } | The node immediately preceding this node. If there is no such node, this returns null. |
| ReadyState { get; } | 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. |
| Referrer { get; } | 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). |
| RootElement { get; } | The root ‘svg’ in the document hierarchy. |
| StrictErrorChecking { get; set; } | 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. |
| StyleSheets { get; } | 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. |
| virtual TextContent { get; set; } | This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to. |
| Title { get; } | The title of a document as specified by the ‘title’ sub-element of the ‘svg’ root element (i.e., Here is the title…) |
| URL { get; } | The complete URI of the document. |
| XmlStandalone { get; set; } | An attribute specifying, as part of the XML declaration, whether this document is standalone. This is false when unspecified. |
| XmlVersion { get; set; } | 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) | This method allows the registration of event listeners on the event target. |
| AddEventListener(string, DOMEventHandler, bool) | This method allows the registration of event listeners on the event target. |
| AddEventListener(string, IEventListener, bool) | This method allows the registration of event listeners on the event target. |
| AppendChild(Node) | Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed. |
| CloneNode() | Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNode is null) and no user data. |
| CloneNode(bool) | Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNode is null) and no user data. |
| CreateAttribute(string) | Creates an Attr of the given name. |
| CreateAttributeNS(string, string) | Creates an attribute of the given qualified name and namespace URI. |
| CreateCDATASection(string) | Creates a CDATASection node whose value is the specified string. |
| CreateComment(string) | Creates a Comment node given the specified string. |
| CreateDocumentFragment() | Creates an empty DocumentFragment object. |
| CreateDocumentType(string, string, string, string) | Creates a DocumentType node. |
| 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. |
| CreateElementNS(string, string) | Creates an element of the given qualified name and namespace 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 namespaces. 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 namespace 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 namespaces 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 namespaceURI 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) | This method allows the dispatch of events into the implementations event model. |
| 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) | Returns the Element that has an ID attribute with the given value. If no such element exists, this returns null. If more than one element has an ID attribute with that value, what is returned is undefined. |
| GetElementsByClassName(string) | Returns a live NodeList object containing all the elements in the document that have all the classes specified in argument. http://www.w3.org/TR/dom/ |
| GetElementsByTagName(string) | Returns a NodeList of all the Elements in document order with a given tag name and are contained in the document. |
| GetElementsByTagNameNS(string, string) | Returns a NodeList of all the Elements with a given local name and namespace URI in document order. |
| GetOverrideStyle(Element, string) | This method is used to retrieve the override style declaration for a specified element and a specified pseudo-element. |
| virtual GetPlatformType() | This method is used to retrieve ECMAScript object Type. |
| HasChildNodes() | Returns whether this node has any children. |
| 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) | Inserts the node before the existing child node child. If child is null, insert node at the end of the list of children. If child is a DocumentFragment object, all of its children are inserted, in the same order, before child. If the child is already in the tree, it is first removed. |
| IsDefaultNamespace(string) | This method checks if the specified namespaceURI is the default namespace or not. |
| IsEqualNode(Node) | Tests whether two nodes are equal. This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode(). All nodes that are the same will also be equal, though the reverse may not be true. |
| IsSameNode(Node) | Returns whether this node is the same node as the given one. This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect. |
| LookupNamespaceURI(string) | Look up the namespace URI associated to the given prefix, starting from this node. |
| LookupPrefix(string) | Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method. See Namespace Prefix Lookup for details on the algorithm used by this method. |
| 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) | Removes the child node indicated by oldChild from the list of children, and returns it. |
| RemoveEventListener(string, IEventListener) | This method allows the removal of event listeners from the event target. If an IEventListener is removed from an EventTarget 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 IEventListener is removed from an EventTarget 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 IEventListener is removed from an EventTarget while it is processing an event, it will not be triggered by the current actions. Event Listeners can never be invoked after being removed. |
| override 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(ResourceHandler) | Saves the document content and resources using the ResourceHandler. |
| 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(ResourceHandler, SVGSaveFormat) | Saves the document content and resources using the ResourceHandler. |
| Save(ResourceHandler, SVGSaveOptions) | Saves the document content and resources using the ResourceHandler. |
| 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”. |
| override 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
- namespace Aspose.Svg
- assembly Aspose.SVG
