StructuredDocumentTag

概述

StructuredDocumentTag 是 Aspose.Words FOSS 中用于 .NET 的类。继承自：CompositeNode、IMarkupNode、ITrackableNode，以及另外 2 个。

表示文档中的结构化文档标签（SDT 或内容控件）。

此类提供了 31 个方法，用于在 .NET 程序中处理 StructuredDocumentTag 对象。可用的方法包括：Accept、AcceptEnd、AcceptStart、AppendChild、Clear、Clone、CreateNavigator、GetAncestor、GetAncestorOf、GetChild、GetChildNodes、GetEnumerator，以及另外 19 个方法。安装 Aspose.Words FOSS for .NET 包后，所有公共成员对任何 .NET 应用程序均可访问。属性：Appearance、BuildingBlockCategory、BuildingBlockGallery、CalendarType、Checked、Color，以及另外 38 项。

属性

名称	类型	访问	描述
`NodeType`	`NodeType`	读取	返回 StructuredDocumentTag。
`Placeholder`	`BuildingBlock`	读取	获取 BuildingBlock，其中包含占位符文本，当此 SDT 运行内容为空、关联映射的 XML 元素为空（通过 XmlMapping 元素指定）或 IsShowingPlaceholderText 元素为 true 时应显示该文本。
`PlaceholderName`	`string`	读写	获取或设置包含占位符文本的 BuildingBlock 的名称。
`Level`	`MarkupLevel`	读取	获取此 SDT 在文档树中出现的层级。
`SdtType`	`SdtType`	读取	获取此结构化文档标签的类型。
`Id`	`int`	读取	为此 SDT 指定唯一的只读持久数值 Id。
`LockContentControl`	`bool`	读写	当设置为 true 时，此属性将阻止用户删除此 SDT。
`LockContents`	`bool`	读写	当设置为 true 时，此属性将阻止用户编辑此 SDT 的内容。
`IsShowingPlaceholderText`	`bool`	读写	指定此 SDT 的内容是否应被解释为占位符文本（而不是 SDT 中的常规文本内容）。
`Tag`	`string`	读写	指定与当前 SDT 节点关联的标签。
`ContentsFont`	`Font`	读取	将应用于输入到 SDT 的文本的字体格式。
`EndCharacterFont`	`Font`	读取	将应用于输入到 SDT 的文本最后一个字符的字体格式。
`IsTemporary`	`bool`	读写	指定当内容被修改时，是否应从 WordProcessingML 文档中删除此 SDT。
`Title`	`string`	读写	指定与此 SDT 关联的友好名称。
`ListItems`	`SdtListItemCollection`	读取	获取与此 SDT 关联的 SdtListItemCollection。
`Checked`	`bool`	读写	获取/设置 Checkbox SDT 的当前状态。
`Appearance`	`SdtAppearance`	读写	获取/设置结构化文档标签的外观。
`DateDisplayLocale`	`int`	读写	允许设置/获取此 SDT 中显示的日期的语言格式。
`DateDisplayFormat`	`string`	读写	表示日期显示格式的字符串。
`FullDate`	`DateTime`	读写	指定最后输入到此 SDT 的完整日期和时间。
`DateStorageFormat`	`SdtDateStorageFormat`	读写	获取/设置当 SDT 绑定到文档数据存储中的 XML 节点时，日期 SDT 的日期存储格式。
`CalendarType`	`SdtCalendarType`	读写	指定此 SDT 的日历类型。
`BuildingBlockGallery`	`string`	读写	指定此 SDT 的构建块类型。
`BuildingBlockCategory`	`string`	读写	指定此 SDT 节点的构建块类别。
`Multiline`	`bool`	读写	指定此 SDT 是否允许多行文本。
`Color`	`System.Drawing.Color`	读写	获取或设置结构化文档标签的颜色。
`Style`	`Style`	读写	获取或设置结构化文档标签的样式。
`StyleName`	`string`	读写	获取或设置应用于结构化文档标签的样式名称。
`XmlMapping`	`XmlMapping`	读取	获取一个对象，该对象表示此结构化文档标签到当前文档自定义 XML 部分中的 XML 数据的映射。
`WordOpenXML`	`string`	读取	获取一个字符串，表示节点中以 FlatOpc 格式包含的 XML。
`WordOpenXMLMinimal`	`string`	读取	获取一个字符串，表示节点中以 FlatOpc 格式包含的 XML。
`IsComposite`	`bool`	读取	返回 true，因为此节点可以拥有子节点。
`HasChildNodes`	`bool`	读取	如果此节点有任何子节点，则返回 true。
`FirstChild`	`Node`	读取	获取节点的第一个子节点。
`LastChild`	`Node`	读取	获取节点的最后一个子节点。
`Count`	`int`	读取	获取此节点的直接子节点数量。
`ParentNode`	`CompositeNode`	读取	获取此节点的直接父节点。
`Document`	`DocumentBase`	读取	获取此节点所属的文档。
`PreviousSibling`	`Node`	读取	获取紧邻此节点之前的节点。
`NextSibling`	`Node`	读取	获取紧跟在此节点之后的节点。
`Range`	`Range`	读取	返回一个 Range 对象，该对象表示此节点中包含的文档部分.
`CustomNodeId`	`int`	读写	指定自定义节点标识符.
`IsMultiSection`	`bool`	读取	如果此实例是范围（多节）结构化文档标签，则返回 true。
`Node`	`Node`	读取	返回实现此接口的 Node 对象。

方法

签名	描述
`StructuredDocumentTag(doc: DocumentBase, type: SdtType, level: MarkupLevel)`	初始化 Structured document tag 类的新实例。
`SetCheckedSymbol(characterCode: int, fontName: string)`	设置用于表示复选框内容控件已选中状态的符号。
`SetUncheckedSymbol(characterCode: int, fontName: string)`	设置用于表示复选框内容控件未选中状态的符号。
`RemoveSelfOnly()`	仅删除此 SDT 节点本身，但保留其内容在文档树中。
`Accept(visitor: DocumentVisitor)`	调用 VisitStructuredDocumentTagStart，随后对智能标签的所有子节点调用 Accept，最后调用 VisitStructuredDocumentTagEnd。
`Clear()`	清除此结构化文档标签的内容，并在已定义占位符时显示该占位符。
`AcceptStart(visitor: DocumentVisitor)`	接受访问者以访问 StructuredDocumentTag 的开始位置。
`AcceptEnd(visitor: DocumentVisitor)`	接受访问者以访问 StructuredDocumentTag 的结束位置。
`GetText()`	获取此节点及其所有子节点的文本。
`GetChildNodes(nodeType: NodeType, isDeep: bool)`	返回匹配指定类型的子节点集合。
`GetChild(nodeType: NodeType, index: int, isDeep: bool)`	返回匹配指定类型的第 N 个子节点。
`SelectNodes(xpath: string)`	选择匹配 XPath 表达式的节点列表。
`SelectSingleNode(xpath: string)`	选择匹配 XPath 表达式的第一个节点。
`GetEnumerator()`	提供对该节点子节点的 for each 风格迭代的支持。
`AppendChild(newChild: T)`	将指定节点添加到该节点的子节点列表的末尾。
`PrependChild(newChild: T)`	将指定的节点添加到该节点的子节点列表的开头。
`InsertAfter(newChild: T, refChild: Node)`	在指定的参考节点之后立即插入指定的节点。
`InsertBefore(newChild: T, refChild: Node)`	在指定的参考节点之前立即插入指定的节点。
`RemoveChild(oldChild: T)`	移除指定的子节点。
`RemoveAllChildren()`	删除当前节点的所有子节点。
`RemoveSmartTags()`	删除当前节点的所有 SmartTag 后代节点。
`IndexOf(child: Node)`	返回子节点数组中指定子节点的索引。
`CreateNavigator()`	创建一个可用于遍历和读取节点的导航器。
`Clone(isCloneChildren: bool)`	当节点克隆是另一个（通常是复合）节点克隆过程的一部分时，您应该使用 Clone(bool, INodeCloningListener) 重载。
`GetAncestor(ancestorType: Type)`	获取指定对象类型的第一个祖先。
`GetAncestorOf()`	在此 StructuredDocumentTag 实例上调用 GetAncestorOf。
`Remove()`	从父节点中移除自身。
`NextPreOrder(rootNode: Node)`	根据先序树遍历算法获取下一个节点。
`PreviousPreOrder(rootNode: Node)`	根据先序树遍历算法获取上一个节点。
`ToString(saveFormat: SaveFormat)`	将节点的内容导出为指定格式的字符串。
`NodeTypeToString(nodeType: NodeType)`	一个将节点类型枚举值转换为用户友好字符串的工具方法。

另请参阅

Aspose.Words for .NET — Enterprise API Reference