SVGTextContentElement

SVGTextContentElement class

The SVGTextContentElement is inherited by various text-related interfaces, such as SVGTextElement, SVGTSpanElement, SVGTRefElement, SVGAltGlyphElement and SVGTextPathElement. For the methods on this interface that refer to an index to a character or a number of characters, these references are to be interpreted as an index to a UTF-16 code unit or a number of UTF-16 code units, respectively. This is for consistency with DOM Level 2 Core, where methods on the CharacterData interface use UTF-16 code units as indexes and counts within the character data.Thus for example, if the text content of a ‘text’ element is a single non-BMP character, such as U+10000, then invoking getNumberOfChars on that element will return 2 since there are two UTF-16 code units(the surrogate pair) used to represent that one character.

public class SVGTextContentElement : SVGGraphicsElement

Properties

Name Description
override Attributes { get; } A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
virtual BaseURI { get; } The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node.
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; } 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.
Children { get; } Returns the child elements of current element.
ClassList { get; } Returns a live DOMTokenList which contains tokens received from parsing the “class” attribute.
ClassName { get; } Corresponds to attribute ‘class’ on the given element.
ClassName { get; set; } The class attribute of the element. This attribute has been renamed due to conflicts with the “class” keyword exposed by many languages. See the class attribute definition in HTML 4.01.
FarthestViewportElement { get; } The farthest ancestor ‘svg’ element. Null if the current element is the outermost svg element.
FirstChild { get; } 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.
FirstElementChild { get; } Returns the first child element node of this element. null if this element has no child elements.
Id { get; set; } The value of the ‘id’ attribute on the given element, or the empty string if ‘id’ is not present.
InnerHTML { get; set; } Returns a fragment of HTML or XML that represents the element’s contents. Can be set, to replace the contents of the element with nodes parsed from the given string.
LastChild { get; } 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
LastElementChild { get; } Returns the last child element node of this element. null if this element has no child elements.
LengthAdjust { get; } Corresponds to attribute ‘lengthAdjust’ on the given element. The value must be one of the length adjust constants defined on this interface.
override 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.
override NamespaceURI { get; } The namespace URI of this node, or null if it is unspecified.
NearestViewportElement { get; } The element which established the current viewport. Often, the nearest ancestor ‘svg’ element. Null if the current element is the outermost svg element.
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 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.
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 nodeValue property of the Node interface returns or sets the value of the current node.
OuterHTML { get; set; } Returns a fragment of HTML or XML that represents the element and its contents. Can be set, to replace the element with nodes parsed from the given string.
virtual OwnerDocument { get; } The read-only ownerDocument property of the Node interface returns the top-level document object of the node.
OwnerSVGElement { get; } The nearest ancestor ‘svg’ element. Null if the given element is the outermost svg element.
ParentElement { get; } 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.
ParentNode { get; } The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree.
override Prefix { get; } 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 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.
RequiredExtensions { get; } Corresponds to attribute ‘requiredExtensions’ on the given element.
RequiredFeatures { get; } Corresponds to attribute ‘requiredFeatures’ on the given element.
SchemaTypeInfo { get; } The type information associated with this element.
ShadowRoot { get; } Returns shadowRoot stored on this element or null if it’s closed.
Style { get; } Corresponds to attribute ‘style’ on the given element. If the user agent does not support styling with CSS, then this attribute must always have the value of null.
SystemLanguage { get; } Corresponds to attribute ‘systemLanguage’ on the given element.
TagName { get; } The name of the element.
override 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.
TextLength { get; } Corresponds to attribute ‘textLength’ on the given element.
Transform { get; } Corresponds to attribute ‘transform’ on the given element.
ViewportElement { get; } The element which established the current viewport. Often, the nearest ancestor ‘svg’ element. Null if the given element is the outermost svg element.

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).
AttachShadow(ShadowRootMode) Creates shadow root and attaches it to current element.
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.
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.
GetAttribute(string) Retrieves an attribute value by name.
GetAttributeNode(string) Retrieves an attribute node by name.
GetAttributeNodeNS(string, string) Retrieves an Attr node by local name and namespace URI.
GetAttributeNS(string, string) Retrieves an attribute value by local name and namespace URI.
GetBBox() Returns the tight bounding box in current user space (i.e., after application of the ‘transform’ attribute, if any) on the geometry of all contained graphics elements, exclusive of stroking, clipping, masking and filter effects). Note that getBBox must return the actual bounding box at the time the method was called, even in case the element has not yet been rendered.
GetComputedTextLength() The total sum of all of the advance values from rendering all of the characters within this element, including the advance value on the glyphs (horizontal or vertical), the effect of properties ‘kerning’, ‘letter-spacing’ and ‘word-spacing’ and adjustments due to attributes ‘dx’ and ‘dy’ on ‘tspan’ elements. For non-rendering environments, the user agent shall make reasonable assumptions about glyph metrics.
GetCTM() Returns the transformation matrix from current user units (i.e., after application of the ‘transform’ attribute, if any) to the viewport coordinate system for the nearestViewportElement.
GetElementsByClassName(string) Returns HTMLCollection object containing all the elements within element that have all the classes specified in argument.
GetElementsByTagName(string) Returns HTMLCollection object containing all elements with a given tag name, in document order.
GetElementsByTagNameNS(string, string) Returns HTMLCollection object containing all elements with a given local name and namespace URI string in document order.
GetNumberOfChars() Returns the total number of characters available for rendering within the current element, which includes referenced characters from ‘tref’ reference, regardless of whether they will be rendered. Effectively, this is equivalent to the length of the Node::textContent attribute from DOM Level 3 Core ([DOM3], section 1.4), if that attribute also expanded ‘tref’ elements.
virtual GetPlatformType() This method is used to retrieve the ECMAScript object .
GetScreenCTM() Returns the transformation matrix from current user units (i.e., after application of the ‘transform’ attribute, if any) to the parent user agent’s notice of a “pixel”. For display devices, ideally this represents a physical screen pixel. For other devices or environments where physical pixel sizes are not known, then an algorithm similar to the CSS2 definition of a “pixel” can be used instead. Note that null is returned if this element is not hooked into the document tree. This method would have been more aptly named as getClientCTM, but the name getScreenCTM is kept for historical reasons.
HasAttribute(string) Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.
HasAttributeNS(string, string) Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise.
override HasAttributes() Returns whether this node (if it is an element) has any attributes
HasChildNodes() The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.
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 namespace URI as an argument. It returns a boolean value that is true if the namespace is the default namespace 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 namespace 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 namespace URI, if present, and null if not. When multiple prefixes are possible, the first prefix is returned.
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
Remove() Removes this instance.
RemoveAttribute(string) Removes an attribute by name.
RemoveAttributeNode(Attr) Removes the specified attribute node.
RemoveAttributeNS(string, string) Removes an attribute by local name and namespace URI.
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.
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.
SetAttribute(string, string) Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter
SetAttributeNode(Attr) Adds a new attribute node. If an attribute with that name (nodeName) is already present in the element, it is replaced by the new one.
SetAttributeNodeNS(Attr) Adds a new attribute. If an attribute with that local name and that namespace URI is already present in the element, it is replaced by the new one.
SetAttributeNS(string, string, string) Adds a new attribute. If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter.
SetIdAttribute(string, bool) If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute.
SetIdAttributeNode(Attr, bool) If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute.
SetIdAttributeNS(string, string, bool) If the parameter isId is true, this method declares the specified attribute to be a user-determined ID attribute.
override ToString() Returns a String that represents this instance.

Fields

Name Description
const LENGTHADJUST_SPACING Corresponds to value ‘spacing’.
const LENGTHADJUST_SPACINGANDGLYPHS Corresponds to value ‘spacingAndGlyphs’.
const LENGTHADJUST_UNKNOWN The enumeration was set to a value that is not one of predefined types. It is invalid to attempt to define a new value of this type or to attempt to switch an existing value to this type.

See Also