matlab.io.xml.dom.Attr class

Package:matlab.io.xml.dom

Attribute of XML element

expand all in page

Description

Amatlab.io.xml.dom.Attrobject represents an attribute of an XML element.

Thematlab.io.xml.dom.Attrclass is ahandleclass.

Class Attributes

`ConstructOnLoad`	`true`
`HandleCompatible`	`true`

For information on class attributes, seeClass Attributes.

Creation

Create amatlab.io.xml.dom.Attrobject by using one of these approaches:

Create anAttrobject by using thecreateAttributeorcreateAttributeNSmethods of amatlab.io.xml.dom.Documentobject. Add theAttrobject to amatlab.io.xml.dom.Elementobject by using thesetAttributeNodeorsetAttributeNodeNSmethods of theElementobject.
Create and add anAttrobject to amatlab.io.xml.dom.Elementobject by using thesetAttributeorsetAttributeNSmethods of theElementobject.

Properties

expand all

`IsID`—Whether attribute is ID attribute
`false`(default) |`true`

Whether this attribute is an ID attribute, specified astrueorfalse.

如果an element has an ID attribute with a unique value, you can use thegetElementByIDmethod of the document to access the element.

Attributes:

`GetAccess`	`公共`
`SetAccess`	`immutable`
`Transient`	`true`
`NonCopyable`	`true`

`Name`—Attribute name
character vector

Name of this attribute, specified as a character vector.

Attributes:

`GetAccess`	`公共`
`SetAccess`	`immutable`
`Transient`	`true`
`NonCopyable`	`true`

`Value`—Attribute value
character vector|string scalar

Value of this attribute, specified as a character vector or string scalar.

Attributes:

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`true`

Methods

expand all

Public Methods

`cloneNode`	`docClone = cloneNode(thisAttr,deep)`creates and returns a copy of this`matlab.io.xml.dom.Attr`object. If`deep`is`true`,副本是一个深拷贝。如果`deep`is`false`, the copy is a shallow copy.
`compareDocumentPosition`	`posEnum = compareDocumentPosition(AttrNode,otherNode)`returns a double value that encodes the position of a node relative to the position of this attribute node in the document that owns the nodes. To decode the returned value,`posEnum`, use the MATLAB expression`bitor(posEnum,POSITION_ENUM) == posEnum`, where`POSITION_ENUM`is one of these`Attr`methods: DOCUMENT_POSITION_FOLLOWING — The other node follows this attribute node. DOCUMENT_POSITION_PRECEDING — The other node precedes this attribute node. DOCUMENT_POSITION_CONTAINED_BY — This attribute node contains the other node, which also follows this node. DOCUMENT_POSITION_CONTAINS — The other node contains this attribute node and also precedes this node. DOCUMENT_POSITION_DISCONNECTED — The two nodes are disconnected. For example: importmatlab.io.xml.dom.*d = Document('root'); root = getDocumentElement(d); setAttribute(root,"Color","red"); a = getAttributeNode(root,"Color"); pos = compareDocumentPosition(a,root);ifbitor(pos,a.DOCUMENT_POSITION_CONTAINS) == pos disp("root contains color attribute");elsedisp("root does not contain color attribute");end
`getBaseURI`	`name = getBaseURI(thisAttr)`returns the base URI of this attribute node as a character vector. If the base URI is not known, the method returns an empty character array. The base URI of an attribute node is the URI of the document that owns the attribute node.
`getLength`	`count = getLength(thisAttr)`returns the number of child nodes of this attribute as a double.
`getLocalName`	`name = getLocalName(thisAttr)`returns the local name of this attribute as a character vector. For example, this method returns 'color' for an attribute named`'w:color'`.
`getNextSibling`	`getNextSibling(thisText)`returns an empty node because attributes are not children.
`getName`	`name = getName(thisAttr)`returns the name of this attribute as a character vector. For example, if the name of this attribute is`'color'`, this method returns`'color'`.
`getNamespaceURI`	`uri = getNamespaceURI(thisAttr)`returns the namespace URI of this attribute or an empty character array if the attribute does not have a namespace URI.
`getNodeName`	`name = getNodeName(thisAttr)`returns the name of this attribute as a character vector. For example, if the name of this attribute is`'color'`, this method returns`'color'`.
`getNodeType`	`type = getNodeType(thisText)`returns the double`2`, which indicates that this node is an attribute node. This method provides compatibility with existing MATLAB^®code that is based on the W3C XML DOM standard. For new MATLAB code, use`isa`to determine the type of a node. For example: importmatlab.io.xml.dom.*d = Document('root'); root = getDocumentElement(d); setAttribute(root,"Color","red"); attrNode = getAttributeNode(root,"Color")ifisa(attrNode,'matlab.io.xml.dom.Attr') fprintf('This is an attribute node.\n');end
`getNodeTypeName`	`name = getNodeTypeName(thisAttr)`returns`'ATTRIBUTE_NODE'`.
`getNodeValue`	`值= getNodeValue (thisAttr)`returns the value of this attribute as a character vector.
`getOwnerElement`	`elem = getOwnerElement(thisAttr)`returns the element that owns this attribute as a`matlab.io.xml.dom.Element`object. The owner element is the element that has this attribute.
`getOwnerDocument`	`doc = getOwnerDocument(thisAttr)`returns the document that owns this attribute node as a`matlab.io.xml.dom.Document`object. The owner document is the document that created or imported this attribute node.
`getParentNode`	`巴勒斯坦权力机构rent = getParentNode(thisAttr)`returns an empty node because attributes are not children.
`getPrefix`	`prefix = getPrefix(thisAttr)`returns the namespace prefix of this attribute. For example, this method returns`'w'`for an attribute named`'w:color'`. If the attribute name does not have a prefix, this method returns an empty character array.
`getPreviousSibling`	`getPreviousSibling(thisAttr)`returns an empty node because attributes are not children.
`getSchemaTypeInfo`	`typeInfo = getSchemaTypeInfo(thisAttr)`returns the information about the schema type of this attribute as a`matlab.io.xml.dom.TypeInfo`object.
`getSpecified`	`tf = getSpecified(thisAttr)`returns`true`if the value of this attribute was specified in the XML markup from which it was parsed or was set programmatically. This method returns`false`if the default value for this attribute was specified in the DTD of the document file from which this attribute was parsed.
`getTextContent`	`getTextContent(thisAttr)`returns the value of this attribute as a character vector.
`getValue`	`getValue(thisAttr)`returns the value of this attribute as a character vector.
`isEqualNode`	`tf = isEqualNode(thisAttr,otherNode)`returns`true`if the node specified by`otherNode`is an attribute node and has the same name as this attribute node. This method tests for equality of nodes, not whether the nodes are handles to the same object. To test for sameness, use the`isSameNode`method. Nodes that are the same are also equal, but nodes that are equal are not necessarily the same. Normalize documents before testing them for equality because normalization can affect equality.
`isID`	`tf = isID(thisAttr)`returns`true`if this attribute is an ID attribute. 如果an element has an ID attribute with a unique value, you can use the`getElementByID`method of the document to access the element.
`isSameNode`	`tf = isSameNode(thisAttr,otherNode)`returns`true`if`otherNode`is the same node as`thisAttr`.
`lookupNamespaceURI`	`uri = lookupNamespaceURI(thisAttr,prefix)`returns the namespace URI associated with`prefix`. If this attribute does not associate a URI with the specified prefix, the method returns an empty character array.
`lookupPrefix`	`prefix = lookupPrefix(thisAttr,namespaceURI)`returns the prefix associated with`namespaceURI`. If this attribute does not associate a prefix with the specified URI, the method returns an empty character array.
`setNodeValue`	`setNodeValue(thisAttr,value)`sets the value of this attribute to the value specified by`value`. Specify`value`as a character vector or string scalar.
`setTextContent`	`setTextContent(thisAttr,textValue)`sets the value of this attribute node to the value specified by`textValue`. Specify`textContent`as a character vector or string scalar.
`setValue`	`setValue(thisAttr,value)`sets the value of this attribute. Specify`value`as a character vector or string scalar.

Examples

collapse all

Add an Attribute to an Element

Open Live Script

This example creates and adds amatlab.io.xml.dom.Attrobject to amatlab.io.xml.dom.Elementobject by using thesetAttributemethod of theElementobject.

Import thematlab.io.xml.dom巴勒斯坦权力机构ckage so that you do not have to use long, fully qualified class names.

importmatlab.io.xml.dom.*

Create a document with the root element帕拉.

doc = Document("para"); para = getDocumentElement(doc);

Add aColorattribute to the帕拉element.

setAttribute(para,"Color","red");

Add text to the帕拉element.

textNode = createTextNode(doc,"Hello"); appendChild(para,textNode);

Write the XML to a file.

xmlFileName ="para.xml"; writer = matlab.io.xml.dom.DOMWriter; writeToFile(writer,doc,xmlFileName);

Create an Attribute and Add It to an Element

Open Live Script

This example creates an attribute using thecreateAttributemethod of the owner document and adds the attribute to an element using thesetAttributeNodemethod of the element.

Import thematlab.io.xml.dom巴勒斯坦权力机构ckage so that you do not have to use long, fully qualified class names.

importmatlab.io.xml.dom.*

Create a document with the root element帕拉.

doc = Document("para"); para = getDocumentElement(doc);

Create an attributeColorand set the attribute value.

attrObj = createAttribute(doc,"Color"); setValue(attrObj,"red");

Add theColorattribute to the帕拉element.

setAttributeNode(para,attrObj);

Create a text node and add it to the帕拉element.

textNode = createTextNode(doc,"Hello"); appendChild(para,textNode);

Write the XML to a file.

xmlFileName ="para.xml"; writer = matlab.io.xml.dom.DOMWriter; writeToFile(writer,doc,xmlFileName);

版本;n History

Introduced in R2021a

matlab.io.xml.dom.Attr class

Description

Class Attributes

Creation

Properties

IsID—Whether attribute is ID attributefalse(default) |true

Attributes:

Name—Attribute namecharacter vector

Attributes:

Value—Attribute valuecharacter vector|string scalar

Attributes:

Methods

Public Methods

Examples

Add an Attribute to an Element

Create an Attribute and Add It to an Element

版本;n History

See Also

`IsID`—Whether attribute is ID attribute
`false`(default) |`true`

`Name`—Attribute name
character vector

`Value`—Attribute value
character vector|string scalar