matlab.io.xml.dom.Element 类

命名空间: matlab.io.xml.dom

XML 文档的元素

自 R2021a 起

描述

matlab.io.xml.dom.Element 类的一个对象，表示 XML 标记。

matlab.io.xml.dom.Element 类是一个 handle 类。

类属性

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

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

创建对象

使用 matlab.io.xml.dom.Document 对象的 createElement 或 createElementNS 方法创建 matlab.io.xml.dom.Element 对象。

属性

全部展开

`Children` — 此元素的子节点
子节点的 1×N 数组

此元素的子节点，指定为由 matlab.io.xml.dom 对象组成的 1×N 数组。

属性：

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

`TagName` — 元素的标记名称
字符向量

此元素的标记名称，指定为字符向量。

属性：

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

`TextContent` — 元素的文本内容
`''` (默认) | 字符向量 | 字符串标量

此元素的文本内容，指定为字符向量或字符串标量。此属性包含此节点及其子级的串联文本内容。

属性：

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

`HasAttributes` — 此元素是否具有属性
`false` (默认) | true

此元素是否具有属性，指定为 true 或 false。

属性：

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

方法

全部展开

公共方法

`appendChild`	`childNode = appendChild(thisElem,childNode)` 向此 `Element` 节点追加一个节点，并返回追加的节点对象。
`cloneNode`	`docClone = cloneNode(thisElem,deep)` 创建并返回此 `matlab.io.xml.dom.Element` 对象的副本。如果 `deep` 为 `true`，则该副本是深拷贝。如果 `deep` 为 `false`，则该副本为浅拷贝。
`compareDocumentPosition`	`posEnum = compareDocumentPosition(thisElem,otherNode)` 返回一个双精度值，该值对此元素在文档中的节点位置相对于此元素在文档中的位置进行编码。要解码返回的值 `posEnum`，请使用 MATLAB 表达式 `bitor(posEnum,POSITION_ENUM) == posEnum`，其中 `POSITION_ENUM` 是以下 `Element` 方法之一： 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); para = createElement(d,"para"); appendChild(root,para); pos = compareDocumentPosition(para,root); if bitor(pos,para.DOCUMENT_POSITION_CONTAINS) == pos disp("root contains paragraph"); else disp("root does not contain paragraph"); end
`getAttribute`	`val = getAttribute(thisElem,name)` 返回具有指定名称的属性值；如果元素没有指定的属性，则返回空字符数组。以字符向量或字符串标量形式指定 `name`。
`getAttributeNode`	`attr = getAttributeNode(thisElem,name)` 返回 `matlab.io.xml.dom.Attr` 对象，该对象表示具有指定名称的元素属性。如果此元素没有指定的属性，该方法将返回空的 `Attr` 对象。以字符向量或字符串标量形式指定 `name`。
`getAttributeNodeNS`	`attr = getAttributeNodeNS(thisElem,namespaceURI,localName)` 返回 `matlab.io.xml.dom.Attr` 对象，该对象表示具有指定命名空间 URI 和本地名称的元素属性。如果此元素没有指定的属性，该方法将返回空的节点对象。 `namespaceURI` 和 `lacalName` 指定为字符向量或字符串标量。
`getAttributeNS`	`val = getAttributeNS(thisElem,namespaceURI,localName)` 返回具有指定命名空间 URI 和本地名称的属性的值。如果此元素没有指定的属性，则该方法返回空字符数组。 `namespaceURI` 和 `localName` 指定为字符向量或字符串标量。
`getAttributes`	`attrs = getAttributes(thisElem)` 返回 `matlab.io.xml.dom.NamedNodeMap` 对象，该对象包含表示此元素的属性的 `Attr` 对象。
`getBaseURI`	`name = getBaseURI(thisElem)` 以字符向量形式返回此元素的基本 URI。如果基本 URI 未知，则该方法返回空字符数组。元素的基本 URI 是拥有该元素的文档的 URI。
`getChildElementCount`	`count = getChildElementCount(thisElem)` 返回作为元素的子级的数量；如果没有元素形式的子级，则返回 `0`。
`getChildNodes`	`nodeList = getChildNodes(thisElem)` 以 `matlab.io.xml.dom.NodeList` 对象形式返回此元素的子级。
`getChildren`	`nodes = getChildren(thisElem)` 返回一个 1×N 对象数组，如 `matlab.io.xml.dom.Element` 或 `matlab.io.xml.dom.Text` 对象，这些对象表示此元素的子级。
`getElementsByTagName`	`list = getElementsByTagName(thisElem,name)` 返回 `matlab.io.xml.dom.NodeList` 对象，该对象列出与指定标记名匹配的此元素的后代元素。以字符向量或字符串标量形式指定 `name`。要匹配所有标记名称，请指定 `""` 或 `''`。 `NodeList` 对象按照元素在包含此元素的文档树遍历中出现的顺序列出元素，从此元素开始。
`getElementsByTagNameNS`	`list = getElementsByTagNameNS(thisElem,namespaceURI,localName)` 返回 `matlab.io.xml.dom.NodeList` 对象，该对象列出此元素的后代元素，这些后代元素与指定的命名空间 URI 和本地名称匹配。要匹配所有命名空间 URI 和本地名称，请指定 `""` 或 `''`。 `NodeList` 对象按照元素在包含此元素的文档树遍历中出现的顺序列出元素，从此元素开始。
`getFirstChild`	`child = getFirstChild(thisElem)` 返回此元素的第一个子级。
`getFirstElementChild`	`childElem = getFirstElementChild(thisElem)` 返回此元素的第一个子元素。如果此元素没有子元素，则该方法返回空对象。
`getLastChild`	`child = getLastChild(thisElem)` 返回此元素的最后一个子元素。
`getLastElementChild`	`childElem = getLastElementChild(thisElem)` 返回此元素的最后一个子元素。如果此元素没有子元素，则该方法返回空对象。
`getLocalName`	`name = getLocalName(thisElem)` 以字符向量形式返回此元素的本地名称。例如，此方法对名为 `'w:p'` 的元素返回 `'p'`。
`getNamespaceURI`	`uri = getNamespaceURI(thisElem)` 以字符向量形式返回此元素的命名空间 URI。如果元素没有命名空间 URI，则该方法返回空字符向量。
`getNextSibling`	`getNextSibling(thisElem)` 返回此元素的父级的子列表中跟在此元素后面的节点。
`getNextElementSibling`	`elem = getNextElementSibling(thisElem)` 返回紧跟在此元素的父级的子列表中此元素之后的元素。如果此元素后面没有元素，则该方法返回空对象。
`getNodeIndex`	`index = getNodeIndex(thisElem)` 返回此元素相对于此元素所在文档中第一个节点的位置。索引计数包括属性。
`getNodeName`	`name = getNodeName(thisElem)` 返回此元素的标记名称。此方法提供与基于 W3C XML DOM 标准的现有 MATLAB^® 代码的兼容性。在新代码中，请改用 `getTagName`。
`getNodeType`	`type = getNodeType(thisElem)` 返回双精度值 `1`，表示此节点是元素。此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。对于新的 MATLAB 代码，请使用 `isa` 来确定节点的类型。例如： import matlab.io.xml.dom.* d = Document('book'); para = createElement(d,"para"); if isa(para,'matlab.io.xml.dom.Element') fprintf('This is an element.\n'); end
`getNodeTypeName`	`name = getNodeTypeName(thisElem)` 返回 `'ELEMENT_NODE'`。
`getNodeValue`	`value = getNodeValue(thisElem)` 返回此元素的节点值。元素的节点值是空字符数组。此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。
`getOwnerDocument`	`doc = getOwnerDocument(thisElem)` 以 `matlab.io.xml.dom.Document` 对象形式返回拥有此元素的文档。所有者文档是创建或导入此元素的文档。
`getParentNode`	`parent = getParentNode(thisElem)` 返回此元素的父节点。如果此元素没有父级，则该方法返回空节点。
`getPrefix`	`prefix = getPrefix(thisElem)` 返回此元素的命名空间前缀。例如，此方法对名为 `'w:p'` 的元素返回 `'w'`。如果元素名称没有前缀，此方法将返回空字符数组。
`getPreviousSibling`	`getPreviousSibling(thisElem)` 返回此元素的父节点的子列表中位于此元素之前的节点。如果此元素之前没有节点，则该方法返回空节点对象
`getPreviousElementSibling`	`elem = getPreviousElementSibling(thisElem)` 返回紧挨在此元素的父级的子列表中此元素之前的元素。如果此元素之前没有节点，则该方法返回空节点对象。
`getSchemaTypeInfo`	`info = getSchemaTypeInfo(thisElem)` 返回 `matlab.io.xml.dom.TypeInfo` 对象，该对象指定定义此元素的架构类型的名称、命名空间和派生。仅当元素包含架构类型信息时，`TypeInfo` 对象才包含类型信息。仅当元素所在文档的解析器配置为根据架构验证文档并将验证后的架构信息 (PSVI) 保存在解析的元素和属性中时，元素才会包含架构信息。
`getTagName`	`name = getTagName(thisElem)` 以字符向量形式返回此元素的名称。该名称对应于元素的 XML 标记中的名称。例如，如果此元素表示标记 `<para>Hello World</para>`，则该方法返回 `'para'`。
`getTextContent`	`getTextContent(thisElem)` 返回此元素的文本内容。如果此元素有子级，则此方法返回子级的串联文本内容。
`hasAttribute`	如果此元素包含具有指定名称的属性，则 `tf = hasAttribute(thisElem,name)` 返回 `true`。
`hasAttributeNS`	如果此元素包含具有指定命名空间 URI 和本地名称的属性，则 `tf = hasAttributeNS(thisElem,namespaceURI,localName)` 返回 `true`。
`hasAttributes`	如果此元素有属性，则 `tf = hasAttributes(thisElem)` 返回 `true`。
`hasChildNodes`	如果此元素有子级，则 `tf = hasChildNodes(thisElem)` 返回 `true`。
`isDefaultNamespace`	如果 `namespaceURI` 指定的命名空间是此元素的默认命名空间，则 `tf = isDefaultNamespace(thisElem,namespaceURI)` 返回 `true`。默认命名空间是在声明时不带前缀的元素命名空间。任何名称中不带前缀的元素及其所有子级都属于默认命名空间。使用 `setAttributeNS` 为元素声明默认命名空间。您可以使用 `Document(namespaceURI,qualifiedName)` 语法为文档的根元素声明默认命名空间。 import matlab.io.xml.dom.* nsURI = "http://my.namespace.org/mybook"; d = Document(nsURI,'book'); book = getDocumentElement(d); if isDefaultNamespace(book,nsURI) fprintf(... '"%s" is the default namespace\n',nsURI); end
`isEqualNode`	如果 `otherNode` 指定的节点是元素，并且该节点的以下属性的值等于此元素的对应属性的值，则 `tf = isEqualNode(thisElem,otherNode)` 返回 `true`：标记名称前缀本地名称命名空间 URI 基本 URI 如果属性值具有相同的长度并且是字符对字符相等，则属性值相等。节点所有者文档和属性值不影响相等性。此方法测试节点的相等性，而不测试节点是否为同一对象的句柄。要测试相同性，请使用 `isSameNode` 方法。相同的节点也会相等，但相等的节点未必相同。在测试文档的相等性之前请先对它们进行标准化，因为标准化会影响相等性。
`isSameNode`	如果 `otherNode` 与 `thisElem` 是同一个节点，则 `tf = isSameNode(thisElem,otherNode)` 返回 `true`。
`lookupNamespaceURI`	`uri = lookupNamespaceURI(thisElem,prefix)` 返回与 `prefix` 关联的命名空间 URI。如果前缀与 URI 无关联，则该方法返回空字符数组。
`lookupPrefix`	`prefix = lookupPrefix(thisElem,namespaceURI)` 以字符向量形式返回与指定命名空间 URI 相关联的前缀。如果此元素没有将前缀与命名空间 URI 相关联，则该方法返回空字符数组。
`normalize`	`normalize(thisElem)` 从此元素中删除空文本节点，并将相邻的文本节点合并成一个文本节点。标准化确保元素结构与保存和重新加载包含元素的文档后的结构相同。
`removeAttribute`	`removeAttribute(thisElem,name)` 从此元素中删除具有指定 `name` 的属性。以字符向量或字符串标量形式指定 `name`。如果指定的属性具有默认值，则该方法会将该属性替换为符合以下条件的属性：具有默认值，并且与被替换属性具有相同的名称或命名空间 URI 和本地名称。
`removeAttributeNode`	`removeAttributeNode(thisElem,attrObj)` 从元素中删除 `attrObj` 指定的属性。将 `attrObj` 指定为 `matlab.io.xml.dom.Attr` 对象。如果指定的属性具有默认值，则该方法会将该属性替换为符合以下条件的属性：具有默认值，并且与被替换属性具有相同的名称或命名空间 URI 和本地名称。
`removeAttributeNS`	`removeAttributeNS(thisElem,namespaceURI,localName)` 从此元素中删除具有指定的命名空间 URI 和本地名称的属性。如果指定的属性具有默认值，则该方法会将该属性替换为符合以下条件的属性：具有默认值，并且与被替换属性具有相同的名称或命名空间 URI 和本地名称。
`removeChild`	`child = removeChild(thisElem,child)` 从此元素中删除 `child` 指定的子节点，并返回删除的子节点。
`replaceChild`	`child = replaceChild(thisElem,newChild,oldChild)` 用 `newChild` 指定的节点替换 `oldChild` 指定的子节点，并返回 `newChild`。如果新子级是 `matlab.io.xml.dom.DocumentFragment` 对象，则该方法将旧子级替换为 `DocumentFragment` 对象的所有子级，并以相同的顺序插入这些子级。如果新子级已在文档树中，则该方法会先从文档中删除该子级，然后再替换旧子级。
`setAttribute`	如果此元素尚未包含具有此名称的属性，则 `setAttribute(thisElem,name,value)` 将具有指定名称和值的属性添加到此元素。如果元素包含具有指定名称的属性，则该方法会将其属性值设置为指定值。将 `name` 和 `value` 指定为字符向量或字符串标量。由于该方法将该值视为 CDATA，因此该方法会忽略值字符串中的标记文本，包括实体引用。要将属性设置为包含实体引用的值，如 `&`，请创建一个具有该值的 `matlab.io.xml.dom.Attr` 节点，然后使用 `setAttributeNode` 将 `Attr` 节点添加到元素中。
`setAttributeNode`	如果元素不包含同名的属性，则 `newAttr = setAttributeNode(thisElem,attrNode)` 将指定的属性添加到此元素。如果此元素已包含同名属性，则该方法会用新属性替换现有属性，并返回被替换的属性。将 `attrNode` 指定为 `matlab.io.xml.dom.Attr` 对象。该方法以 `matlab.io.dom.xml.Attr` 对象形式返回新属性。
`setAttributeNodeNS`	如果元素不包含具有指定命名空间 URI 和本地名称的属性，则 `newAttr = setAttributeNodeNS(thisElem,attrNode)` 将向此元素添加该属性节点。如果此元素已包含具有相同命名空间 URI 和本地名称的属性，则该方法用新属性替换现有属性，并返回被替换的属性。将 `attrNode` 指定为 `matlab.io.xml.dom.Attr` 对象。该方法以 `matlab.io.dom.xml.Attr` 对象形式返回新属性。
`setAttributeNS`	如果此元素不包含具有指定名称的属性，则 `setAttribute(thisElem,namespaceURI,localName,value)` 将具有指定命名空间 URI、本地名称和值的属性添加到此元素。如果此元素已包含具有指定命名空间 URI 和本地名称的属性，则此方法会将现有属性的值设置为指定值。将 `namespaceURI`、`localName` 和 `value` 指定为字符向量或字符串标量。由于该方法将该值视为 CDATA，因此该方法会忽略值字符串中的标记文本，包括实体引用。要将属性设置为包含实体引用的值，如 `&`，请创建一个具有该值的 `matlab.io.xml.dom.Attr` 节点，然后使用 `setAttributeNodeNS` 将 `Attr` 节点添加到元素中。
`setIDAttribute`	`setIDAttribute(thisElem,name,true)` 声明具有指定名称的元素属性是 ID 属性。 `setIDAttribute(thisElem,name,false)` 声明具有指定名称的元素属性不是 ID 属性。以字符向量或字符串标量形式指定 `name`。
`setIDAttributeNode`	`setIDAttributeNode(thisElem,attrNode,true)` 声明 `attrNode` 指定的元素属性是 ID 属性。 `setIDAttributeNode(thisElem,attrNode,false)` 声明 `attrNode` 指定的元素属性不是 ID 属性。将 `attrNode` 指定为 `matlab.io.xml.dom.Attr` 对象。
`setIDAttributeNS`	`setIDAttributeNS(thisElem,namespaceURI,localName,true)` 声明具有指定命名空间 URI 和本地名称的元素属性是 ID 属性。 `setIDAttributeNS(thisElem,namespaceURI,localName,false)` 声明具有指定命名空间 URI 和本地名称的元素属性不是 ID 属性。 `spaceURI` 和 `localName` 指定为字符向量或字符串标量。
`setNodeValue`	`setNodeValue` 不起作用。此方法提供与基于 W3C XML DOM 标准的现有 MATLAB 代码的兼容性。
`setTextContent`	`setTextContent(thisElem,textContent)` 用包含指定文本的 `matlab.io.xml.dom.Text` 节点替换此元素中的现有节点。以字符向量或字符串标量形式指定 `textContent`。

示例

全部折叠

创建 XML 元素和文本节点

打开实时脚本

此示例创建 matlab.io.xml.dom.Element 和 matlab.io.xml.dom.Text 对象来表示 weekdays 的 XML 标记。

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

import matlab.io.xml.dom.*

创建一个文档和根元素 weekdays。

doc = Document("weekdays");
weekdaysElement = getDocumentElement(doc);

为每个工作日创建一个文本字符串数组。

weekdays = ["Mon" "Tue" "Wed" "Thu" "Fri"];

对于每个工作日，为 day 元素创建一个 Element 对象，为 day 文本创建一个 Text 对象。将 Text 对象追加到 day 元素，将 day 元素追加到 weekdays 元素。

for i=1:5
    dayElement = createElement(doc,"day");
    appendChild(dayElement,createTextNode(doc,weekdays(i)));
    appendChild(weekdaysElement,dayElement);
end

将 XML 写入文件。

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

版本历史记录

在 R2021a 中推出

另请参阅

matlab.io.xml.dom.Document | matlab.io.xml.dom.Text | matlab.io.xml.dom.Attr

matlab.io.xml.dom.Element 类

描述

类属性

创建对象

属性

Children — 此元素的子节点 子节点的 1×N 数组

属性：

TagName — 元素的标记名称 字符向量

属性：

TextContent — 元素的文本内容 '' (默认) | 字符向量 | 字符串标量

属性：

HasAttributes — 此元素是否具有属性 false (默认) | true

属性：

方法