matlab.io.xml.dom.Attr 类

包： matlab.io.xml.dom

XML 元素的属性

自 R2021a 起

说明

matlab.io.xml.dom.Attr 对象表示 XML 元素的属性。

matlab.io.xml.dom.Attr 类是 handle 类。

类属性

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

有关类属性的信息，请参阅类属性。

创建对象

使用以下方法之一创建 matlab.io.xml.dom.Attr 对象：

使用 matlab.io.xml.dom.Document 对象的 createAttribute 或 createAttributeNS 方法创建 Attr 对象。使用 Element 对象的 setAttributeNode 或 setAttributeNodeNS 方法，将 Attr 对象添加到 matlab.io.xml.dom.Element 对象。
使用 Element 对象的 setAttribute 或 setAttributeNS 方法，创建 Attr 对象并将其添加到 matlab.io.xml.dom.Element 对象。

属性

全部展开

`IsID` — 属性是否为 ID 属性
`false` （默认） | `true`

此属性是否为 ID 属性，指定为 true 或 false。

如果元素的 ID 属性具有唯一值，您可以使用文档中的 getElementByID 方法来访问该元素。

属性：

`GetAccess`	`public`
`SetAccess`	`immutable`
`Transient`	`true`
`NonCopyable`	`true`

`Name` — 属性名称
字符向量

此属性的名称，指定为字符向量。

属性：

`GetAccess`	`public`
`SetAccess`	`immutable`
`Transient`	`true`
`NonCopyable`	`true`

`Value` — 属性值
字符向量 | 字符串标量

此属性的值，指定为字符向量或字符串标量。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

方法

全部展开

公共方法

`cloneNode`	`docClone = cloneNode(thisAttr,deep)` 创建并返回此 `matlab.io.xml.dom.Attr` 对象的副本。如果 `deep` 为 `true`，则该副本为深拷贝。如果 `deep` 是 `false`，则该副本是浅拷贝。
`compareDocumentPosition`	`posEnum = compareDocumentPosition(AttrNode,otherNode)` 返回双精度值，该值对一个节点在其所属文档中相对于此属性节点的位置进行编码。要解码返回的值 `posEnum`，请使用 MATLAB 表达式 `bitor(posEnum,POSITION_ENUM) == posEnum`，其中 `POSITION_ENUM` 是以下 `Attr` 方法之一： DOCUMENT_POSITION_FOLLOWING - 另一个节点跟在此属性节点之后。 DOCUMENT_POSITION_PRECEDING - 另一个节点在此属性节点之前。 DOCUMENT_POSITION_CONTAINED_BY - 此属性节点包含另一个节点，后者的位置在此节点之后。 DOCUMENT_POSITION_CONTAINS - 另一个节点包含此属性节点，前者的位置在此节点之前。 DOCUMENT_POSITION_DISCONNECTED - 两个节点彼此不相连。例如： import matlab.io.xml.dom.* d = Document('root'); root = getDocumentElement(d); setAttribute(root,"Color","red"); a = getAttributeNode(root,"Color"); pos = compareDocumentPosition(a,root); if bitor(pos,a.DOCUMENT_POSITION_CONTAINS) == pos disp("root contains color attribute"); else disp("root does not contain color attribute"); end
`getBaseURI`	`name = getBaseURI(thisAttr)` 以字符向量形式返回此属性节点的基本 URI。如果基本 URI 未知，则该方法返回空字符数组。属性节点的基本 URI 是拥有该属性节点的文档的 URI。
`getLength`	`count = getLength(thisAttr)` 以双精度值形式返回此属性的子节点数。
`getLocalName`	`name = getLocalName(thisAttr)` 以字符向量形式返回此属性的本地名称。例如，此方法对名为 `'w:color'` 的属性返回 'color'。
`getNextSibling`	`getNextSibling(thisText)` 返回空节点，因为属性不是子级。
`getName`	`name = getName(thisAttr)` 以字符向量形式返回此属性的名称。例如，如果此属性的名称是 `'color'`，则该方法返回 `'color'`。
`getNamespaceURI`	`uri = getNamespaceURI(thisAttr)` 返回此属性的命名空间 URI，如果此属性没有命名空间 URI，则返回空字符数组。
`getNodeName`	`name = getNodeName(thisAttr)` 以字符向量形式返回此属性的名称。例如，如果此属性的名称是 `'color'`，则该方法返回 `'color'`。
`getNodeType`	`type = getNodeType(thisText)` 返回双精度值 `2`，表示此节点是属性节点。此方法提供与基于 W3C XML DOM 标准的现有 MATLAB^® 代码的兼容性。对于新的 MATLAB 代码，请使用 `isa` 来确定节点的类型。例如： import matlab.io.xml.dom.* d = Document('root'); root = getDocumentElement(d); setAttribute(root,"Color","red"); attrNode = getAttributeNode(root,"Color") if isa(attrNode,'matlab.io.xml.dom.Attr') fprintf('This is an attribute node.\n'); end
`getNodeTypeName`	`name = getNodeTypeName(thisAttr)` 返回 `'ATTRIBUTE_NODE'`。
`getNodeValue`	`value = getNodeValue(thisAttr)` 以字符向量形式返回此属性的值。
`getOwnerElement`	`elem = getOwnerElement(thisAttr)` 以 `matlab.io.xml.dom.Element` 对象形式返回拥有此属性的元素。所有者元素是拥有此属性的元素。
`getOwnerDocument`	`doc = getOwnerDocument(thisAttr)` 以 `matlab.io.xml.dom.Document` 对象形式返回拥有此属性节点的文档。所有者文档是创建或导入此属性节点的文档。
`getParentNode`	`parent = getParentNode(thisAttr)` 返回空节点，因为属性不是子级。
`getPrefix`	`prefix = getPrefix(thisAttr)` 返回此属性的命名空间前缀。例如，此方法对名为 `'w:color'` 的属性返回 `'w'`。如果属性名称没有前缀，此方法将返回空字符数组。
`getPreviousSibling`	`getPreviousSibling(thisAttr)` 返回空节点，因为属性不是子级。
`getSchemaTypeInfo`	`typeInfo = getSchemaTypeInfo(thisAttr)` 以 `matlab.io.xml.dom.TypeInfo` 对象形式返回有关此属性的架构类型的信息。
`getSpecified`	如果此属性值是在解析此属性的 XML 标记中指定的，或是以编程方式设置的，则 `tf = getSpecified(thisAttr)` 返回 `true`。如果此属性的默认值是在解析此属性的文档文件的 DTD 中指定的，则该方法返回 `false`。
`getTextContent`	`getTextContent(thisAttr)` 以字符向量形式返回此属性的值。
`getValue`	`getValue(thisAttr)` 以字符向量形式返回此属性的值。
`isEqualNode`	如果 `otherNode` 指定的节点是属性节点并且与此属性节点同名，则 `tf = isEqualNode(thisAttr,otherNode)` 返回 `true`。此方法测试节点的相等性，而不测试节点是否为同一对象的句柄。要测试相同性，请使用 `isSameNode` 方法。相同的节点也会相等，但相等的节点未必相同。在测试文档的相等性之前请先对它们进行标准化，因为标准化会影响相等性。
`isID`	如果此属性是 ID 属性，则 `tf = isID(thisAttr)` 返回 `true`。如果元素的 ID 属性具有唯一值，您可以使用文档的 `getElementByID` 方法来访问该元素。
`isSameNode`	如果 `otherNode` 与 `thisAttr` 是同一个节点，则 `tf = isSameNode(thisAttr,otherNode)` 返回 `true`。
`lookupNamespaceURI`	`uri = lookupNamespaceURI(thisAttr,prefix)` 返回与 `prefix` 关联的命名空间 URI。如果此属性没有将 URI 与指定的前缀相关联，则该方法返回空字符数组。
`lookupPrefix`	`prefix = lookupPrefix(thisAttr,namespaceURI)` 返回与 `namespaceURI` 关联的前缀。如果此属性没有将前缀与指定的 URI 相关联，则该方法返回空字符数组。
`setNodeValue`	`setNodeValue(thisAttr,value)` 将此属性的值设置为 `value` 指定的值。以字符向量或字符串标量形式指定 `value`。
`setTextContent`	`setTextContent(thisAttr,textValue)` 将此属性节点的值设置为 `textValue` 指定的值。以字符向量或字符串标量形式指定 `textContent`。
`setValue`	`setValue(thisAttr,value)` 设置此属性的值。以字符向量或字符串标量形式指定 `value`。

示例

全部折叠

向元素添加属性

打开实时脚本

此示例通过使用 Element 对象的 setAttribute 方法，创建一个 matlab.io.xml.dom.Attr 对象并将其添加到 matlab.io.xml.dom.Element 对象。

导入 matlab.io.xml.dom 包，这样就不必使用冗长的完全限定类名称。

import matlab.io.xml.dom.*

使用根元素 para 创建文档。

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

向 para 元素添加 Color 属性。

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

向 para 元素添加文本。

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

将 XML 写入文件。

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

创建属性并将其添加到元素

打开实时脚本

此示例使用所有者文档的 createAttribute 方法创建一个属性，并使用元素的 setAttributeNode 方法将该属性添加到元素。

导入 matlab.io.xml.dom 包，这样就不必使用冗长的完全限定类名称。

import matlab.io.xml.dom.*

使用根元素 para 创建文档。

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

创建属性 Color 并设置属性值。

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

将 Color 属性添加到 para 元素。

setAttributeNode(para,attrObj);

创建一个文本节点，并将其添加到 para 元素。

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

将 XML 写入文件。

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

版本历史记录

在 R2021a 中推出

另请参阅

matlab.io.xml.dom.Document | matlab.io.xml.dom.Element