StructuredDocumentTag

遗产: java.lang.Object, com.aspose.words.Node, com.aspose.words.CompositeNode

所有已实现的接口: com.aspose.words.IStructuredDocumentTag

public class StructuredDocumentTag extends CompositeNode implements IStructuredDocumentTag

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

要了解更多信息,请访问Structured Document Tags or Content Control文档文章。

结构化文档标签 (SDT) 允许将客户定义的语义及其行为和外观嵌入到文档中。

在这个版本中,Aspose.Words 提供了一些公共方法和属性来操纵行为和内容StructuredDocumentTag SDT 节点到文档中自定义 XML 包的映射可以使用getXmlMapping()财产。

StructuredDocumentTag可以出现在文档中的以下位置:

构造器

构造函数描述
StructuredDocumentTag(DocumentBase doc, int type, int level)初始化此类的新实例。

方法

方法描述
accept(DocumentVisitor visitor)接待来访者。
appendChild(Node newChild)将指定节点添加到此节点的子节点列表的末尾。
clear()清除此结构化文档标记的内容并显示占位符(如果已定义)。
clearRunAttrs()
dd()
deepClone(boolean isCloneChildren)创建节点的副本。
equals(Object arg0)
fetchInheritedRunAttr(int key)
getAncestor(int ancestorType)
getAncestor(Class ancestorType)获取指定对象类型的第一个祖先。
getAppearance()获取/设置结构化文档标签的外观。
getBuildingBlockCategory()为此指定构建块的类别SDT节点。
getBuildingBlockGallery()为此指定构建块的类型SDT.
getCalendarType()为此指定日历的类型SDT.
getChecked()获取/设置复选框的当前状态SDT.
getChild(int nodeType, int index, boolean isDeep)
getChildNodes()获取此节点的所有直接子节点。
getChildNodes(int nodeType, boolean isDeep)
getClass()
getColor()获取结构化文档标签的颜色。
getContainer()
getContentsFont()将应用于输入的文本的字体格式SDT.
getCount()获取此节点的直接子节点数。
getCurrentNode()
getCustomNodeId()指定自定义节点标识符。
getDateDisplayFormat()表示日期显示格式的字符串。
getDateDisplayLocale()允许设置/获取在此显示的日期的语言格式SDT.
getDateStorageFormat()获取/设置日期 SDT 的日期存储格式,当SDT绑定到文档数据存储中的 XML 节点。
getDirectRunAttr(int key)
getDocument()获取此节点所属的文档。
getEndCharacterFont()将应用于输入文本的最后一个字符的字体格式SDT.
getFirstChild()获取节点的第一个子节点。
getFullDate()指定上次输入的完整日期和时间SDT.
getId()为此指定一个唯一的只读持久数字 IdSDT.
getLastChild()获取节点的最后一个子节点。
getLevel()获取此级别SDT发生在文档树中。
getLevel_IMarkupNode()
getListItems()得到SdtListItemCollection与此相关SDT.
getLockContentControl()当设置为 true 时,此属性将禁止用户删除此SDT.
getLockContents()当设置为 true 时,此属性将禁止用户编辑此文件的内容SDT.
getMultiline()指定这是否SDT允许多行文本。
getNextMatchingNode(Node curNode)
getNextSibling()获取紧跟在该节点之后的节点。
getNodeType()退货NodeType.StructuredDocumentTag.
getParentNode()获取此节点的直接父级。
getPlaceholder()获取BuildingBlock包含应在此 SDT 运行内容为空时显示的占位符文本,关联的映射 XML 元素为空,如通过getXmlMapping()元素或isShowingPlaceholderText() / isShowingPlaceholderText(boolean)元素为真。
getPlaceholderName()获取或设置名称BuildingBlock包含占位符文本。
getPreviousSibling()获取紧接在该节点之前的节点。
getRange()返回一个Range表示包含在该节点中的文档部分的对象。
getSdtType()获取 this 的类型Structured document tag.
getStyle()获取结构化文档标签的样式。
getStyleName()获取应用于结构化文档标签的样式名称。
getTag()指定与当前 SDT 节点关联的标签。
getText()获取此节点及其所有子节点的文本。
getTitle()指定与此关联的友好名称SDT.
getWordOpenXML()获取一个字符串,该字符串表示包含在SaveFormat.FLAT_OPC格式。
getXmlMapping()获取一个对象,该对象表示此结构化文档标记到当前文档的自定义 XML 部分中的 XML 数据的映射。
hasChildNodes()如果此节点有任何子节点,则返回 true。
hashCode()
indexOf(Node child)返回子节点数组中指定子节点的索引。
insertAfter(Node newChild, Node refChild)在指定的引用节点之后立即插入指定的节点。
insertBefore(Node newChild, Node refChild)将指定节点插入到紧靠指定引用节点之前。
isComposite()返回 true,因为此节点可以有子节点。
isRanged()
isShowingPlaceholderText()指定此内容是否SDT应被解释为包含占位符文本(与 SDT 中的常规文本内容相反)。
isShowingPlaceholderText(boolean value)指定此内容是否SDT应被解释为包含占位符文本(与 SDT 中的常规文本内容相反)。
isTemporary()指定这是否SDT当其内容被修改时,应从 WordProcessingML 文档中删除。
isTemporary(boolean value)指定这是否SDT当其内容被修改时,应从 WordProcessingML 文档中删除。
iterator()为该节点的子节点上的每个样式迭代提供支持。
nextPreOrder(Node rootNode)根据前序树遍历算法获取下一个节点。
nodeTypeToString(int nodeType)
notify()
notifyAll()
prependChild(Node newChild)将指定节点添加到此节点的子节点列表的开头。
previousPreOrder(Node rootNode)根据前序树遍历算法获取上一个节点。
remove()从父级中移除自身。
removeAllChildren()移除当前节点的所有子节点。
removeChild(Node oldChild)删除指定的子节点。
removeMoveRevisions()
removeRunAttr(int key)
removeSelfOnly()仅删除此 SDT 节点本身,但将其内容保留在文档树中。
removeSmartTags()删除所有SmartTag当前节点的后代节点。
selectNodes(String xpath)选择与 XPath 表达式匹配的节点列表。
selectSingleNode(String xpath)选择与 XPath 表达式匹配的第一个节点。
setAppearance(int value)获取/设置结构化文档标签的外观。
setBuildingBlockCategory(String value)为此指定构建块的类别SDT节点。
setBuildingBlockGallery(String value)为此指定构建块的类型SDT.
setCalendarType(int value)为此指定日历的类型SDT.
setChecked(boolean value)获取/设置复选框的当前状态SDT.
setCheckedSymbol(int characterCode, String fontName)设置用于表示复选框内容控件的选中状态的符号。
setColor(Color value)设置结构化文档标签的颜色。
setCustomNodeId(int value)指定自定义节点标识符。
setDateDisplayFormat(String value)表示日期显示格式的字符串。
setDateDisplayLocale(int value)允许设置/获取在此显示的日期的语言格式SDT.
setDateStorageFormat(int value)获取/设置日期 SDT 的日期存储格式,当SDT绑定到文档数据存储中的 XML 节点。
setFullDate(Date value)指定上次输入的完整日期和时间SDT.
setLockContentControl(boolean value)当设置为 true 时,此属性将禁止用户删除此SDT.
setLockContents(boolean value)当设置为 true 时,此属性将禁止用户编辑此文件的内容SDT.
setMultiline(boolean value)指定这是否SDT允许多行文本。
setPlaceholderName(String value)获取或设置名称BuildingBlock包含占位符文本。
setRunAttr(int key, Object value)
setStyle(Style value)设置结构化文档标签的样式。
setStyleName(String value)设置应用于结构化文档标签的样式名称。
setTag(String value)指定与当前 SDT 节点关联的标签。
setTitle(String value)指定与此关联的友好名称SDT.
setUncheckedSymbol(int characterCode, String fontName)设置用于表示复选框内容控件的未选中状态的符号。
structuredDocumentTagNode()
toString()
toString(SaveOptions saveOptions)使用指定的保存选项将节点的内容导出为字符串。
toString(int saveFormat)
wait()
wait(long arg0)
wait(long arg0, int arg1)

StructuredDocumentTag(DocumentBase doc, int type, int level)

public StructuredDocumentTag(DocumentBase doc, int type, int level)

初始化此类的新实例。

参数:

范围类型描述
docDocumentBase
typeint
levelint

accept(DocumentVisitor visitor)

public boolean accept(DocumentVisitor visitor)

接待来访者。

枚举此节点及其所有子节点。每个节点调用 DocumentVisitor 上的相应方法。

有关更多信息,请参阅访问者设计模式。

参数:

范围类型描述
visitorDocumentVisitor将访问节点的访问者。

退货: boolean - 如果所有节点都被访问,则为真;如果 DocumentVisitor 在访问所有节点之前停止操作,则返回 false。来电DocumentVisitor.visitStructuredDocumentTagStart(com.aspose.words.StructuredDocumentTag) , 然后调用Node.accept(com.aspose.words.DocumentVisitor)对于智能标签的所有子节点和调用DocumentVisitor.visitStructuredDocumentTagEnd(com.aspose.words.StructuredDocumentTag)在最后。

appendChild(Node newChild)

public Node appendChild(Node newChild)

将指定节点添加到此节点的子节点列表的末尾。

如果 newChild 已经在树中,则首先将其删除。

如果被插入的节点是从另一个文档创建的,你应该使用**M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)**将节点导入当前文档。然后可以将导入的节点插入到当前文档中。

参数:

范围类型描述
newChildNode要添加的节点。

退货: Node - 添加的节点。

clear()

public void clear()

清除此结构化文档标记的内容并显示占位符(如果已定义)。

如果结构化文档标签有修订,则无法清除它的内容。

如果此结构化文档标记映射到自定义 XML(使用getXmlMapping()属性),被引用的 XML 节点被清除。

clearRunAttrs()

public void clearRunAttrs()

dd()

public void dd()

deepClone(boolean isCloneChildren)

public Node deepClone(boolean isCloneChildren)

创建节点的副本。

此方法用作节点的复制构造函数。克隆的节点没有父节点,但与原始节点属于同一个文档。

此方法始终执行节点的深层复制。这isCloneChildren参数指定是否也执行复制所有子节点。

参数:

范围类型描述
isCloneChildrenbooleanTrue 递归克隆指定节点下的子树; false 仅克隆节点本身。

退货: Node - 克隆节点。

equals(Object arg0)

public boolean equals(Object arg0)

参数:

范围类型描述
arg0java.lang.Object

退货: 布尔值

fetchInheritedRunAttr(int key)

public Object fetchInheritedRunAttr(int key)

参数:

范围类型描述
keyint

退货: java.lang.Object

getAncestor(int ancestorType)

public CompositeNode getAncestor(int ancestorType)

参数:

范围类型描述
ancestorTypeint

退货: CompositeNode

getAncestor(Class ancestorType)

public CompositeNode getAncestor(Class ancestorType)

获取指定对象类型的第一个祖先。

参数:

范围类型描述
ancestorTypejava.lang.Class要检索的祖先的对象类型。

退货: CompositeNode - 指定类型的祖先,如果未找到此类型的祖先,则为 null。

如果祖先类型等于 ancestorType 或派生自 ancestorType,则祖先类型匹配。

getAppearance()

public int getAppearance()

获取/设置结构化文档标签的外观。

退货: int - 相应的 int 值。返回值是其中之一SdtAppearance常数。

getBuildingBlockCategory()

public String getBuildingBlockCategory()

为此指定构建块的类别SDT节点。不能为空。

访问此属性仅适用于SdtType.BUILDING_BLOCK_GALLERYSdtType.DOC_PART_OBJSDT 类型。它是只读的SDT文档部件类型。

对于所有其他 SDT 类型,将发生异常。

退货: java.lang.String - 相应的 java.lang.String 值。

getBuildingBlockGallery()

public String getBuildingBlockGallery()

为此指定构建块的类型SDT.不能为空。

访问此属性仅适用于SdtType.BUILDING_BLOCK_GALLERYSdtType.DOC_PART_OBJSDT 类型。它是只读的SDT文档部件类型。

对于所有其他 SDT 类型,将发生异常。

退货: java.lang.String - 相应的 java.lang.String 值。

getCalendarType()

public int getCalendarType()

为此指定日历的类型SDT .默认为SdtCalendarType.DEFAULT

访问此属性仅适用于SdtType.DATESDT 类型。

对于所有其他 SDT 类型,将发生异常。

退货: int - 相应的 int 值。返回值是其中之一SdtCalendarType常数。

getChecked()

public boolean getChecked()

获取/设置复选框的当前状态SDT.此属性的默认值为 false。

访问此属性仅适用于SdtType.CHECKBOX SDT 类型。

对于所有其他 SDT 类型,将发生异常。

退货: boolean - 相应的布尔值。

getChild(int nodeType, int index, boolean isDeep)

public Node getChild(int nodeType, int index, boolean isDeep)

参数:

范围类型描述
nodeTypeint
indexint
isDeepboolean

退货: Node

getChildNodes()

public NodeCollection getChildNodes()

获取此节点的所有直接子节点。

笔记,getChildNodes()相当于调用 GetChildNodes(NodeType.Any, false) 并在每次访问时创建并返回一个新集合。

如果没有子节点,则此属性返回一个空集合。

退货: NodeCollection - 该节点的所有直接子节点。

getChildNodes(int nodeType, boolean isDeep)

public NodeCollection getChildNodes(int nodeType, boolean isDeep)

参数:

范围类型描述
nodeTypeint
isDeepboolean

退货: NodeCollection

getClass()

public final native Class<?> getClass()

退货: java.lang.Class

getColor()

public Color getColor()

获取结构化文档标签的颜色。

退货: java.awt.Color - 结构化文档标签的颜色。

getContainer()

public CompositeNode getContainer()

退货: CompositeNode

getContentsFont()

public Font getContentsFont()

将应用于输入的文本的字体格式SDT.

退货: Font - 相应的Font价值。

getCount()

public int getCount()

获取此节点的直接子节点数。

退货: int - 此节点的直接子节点数。

getCurrentNode()

public Node getCurrentNode()

退货: Node

getCustomNodeId()

public int getCustomNodeId()

指定自定义节点标识符。

默认为零。

这个标识符可以任意设置和使用。例如,作为获取外部数据的密钥。

重要说明,指定的值不会保存到输出文件中,并且仅在节点生命周期内存在。

退货: int - 相应的 int 值。

getDateDisplayFormat()

public String getDateDisplayFormat()

表示日期显示格式的字符串。不能为空。英语(美国)的日期是“mm/dd/yyyy”

访问此属性仅适用于SdtType.DATESDT 类型。

对于所有其他 SDT 类型,将发生异常。

退货: java.lang.String - 相应的 java.lang.String 值。

getDateDisplayLocale()

public int getDateDisplayLocale()

允许设置/获取在此显示的日期的语言格式SDT.

访问此属性仅适用于SdtType.DATESDT 类型。

对于所有其他 SDT 类型,将发生异常。

退货: int - 相应的 int 值。

getDateStorageFormat()

public int getDateStorageFormat()

获取/设置日期 SDT 的日期存储格式,当SDT绑定到文档数据存储中的 XML 节点。默认值为SdtDateStorageFormat.DATE_TIME

访问此属性仅适用于SdtType.DATESDT 类型。

对于所有其他 SDT 类型,将发生异常。

退货: int - 相应的 int 值。返回值是其中之一SdtDateStorageFormat常数。

getDirectRunAttr(int key)

public Object getDirectRunAttr(int key)

参数:

范围类型描述
keyint

退货: java.lang.Object

getDocument()

public DocumentBase getDocument()

获取此节点所属的文档。

该节点始终属于一个文档,即使它刚刚创建并且尚未添加到树中,或者如果它已从树中删除也是如此。

退货: DocumentBase - 该节点所属的文档。

getEndCharacterFont()

public Font getEndCharacterFont()

将应用于输入文本的最后一个字符的字体格式SDT.

退货: Font - 相应的Font价值。

getFirstChild()

public Node getFirstChild()

获取节点的第一个子节点。如果没有第一个子节点,则返回 null。

退货: Node - 节点的第一个孩子。

getFullDate()

public Date getFullDate()

指定上次输入的完整日期和时间SDT.

访问此属性仅适用于SdtType.DATESDT 类型。

对于所有其他 SDT 类型,将发生异常。

退货: java.util.Date - 相应的 java.util.Date 值。

getId()

public int getId()

为此指定一个唯一的只读持久数字 IdSDT.

Id 属性应遵循以下规则:

  • 仅当克隆整个文档时,文档才应保留 SDT idDocument.deepClone().
  • 期间DocumentBase.importNode(com.aspose.words.Node, boolean)如果导入不会与目标文档中的其他 SDT Id 发生冲突,则应保留 Id。
  • 如果多个 SDT 节点为 Id 属性指定了相同的十进制数值,那么文档中的第一个 SDT 将保持这个原始 Id,并且所有后续的 SDT 节点都将在文档加载时分配给它们新的标识符。
  • 在独立 SDT 期间**M:Aspose.Words.Markup.StructuredDocumentTag.Clone(System.Boolean,Aspose.Words.INodeCloningListener)**operation 将为克隆的 SDT 节点生成新的唯一 ID。
  • 如果源文档中未指定 Id,则 SDT 节点应在加载文档时分配一个新的唯一标识符。

退货: int - 相应的 int 值。

getLastChild()

public Node getLastChild()

获取节点的最后一个子节点。如果没有最后一个子节点,则返回 null。

退货: Node - 节点的最后一个孩子。

getLevel()

public int getLevel()

获取此级别SDT发生在文档树中。

退货: int - 这个级别SDT发生在文档树中。返回值是其中之一MarkupLevel常数。

getLevel_IMarkupNode()

public int getLevel_IMarkupNode()

退货: 整数

getListItems()

public SdtListItemCollection getListItems()

得到SdtListItemCollection与此相关SDT.

访问此属性仅适用于SdtType.COMBO_BOX或者SdtType.DROP_DOWN_LIST SDT 类型。

对于所有其他 SDT 类型,将发生异常。

退货: SdtListItemCollection -{SdtListItemCollection与此相关SDT.

getLockContentControl()

public boolean getLockContentControl()

当设置为 true 时,此属性将禁止用户删除此SDT.

退货: boolean - 相应的布尔值。

getLockContents()

public boolean getLockContents()

当设置为 true 时,此属性将禁止用户编辑此文件的内容SDT.

退货: boolean - 相应的布尔值。

getMultiline()

public boolean getMultiline()

指定这是否SDT允许多行文本。

访问此属性仅适用于SdtType.RICH_TEXTSdtType.PLAIN_TEXTSDT 类型。

对于所有其他 SDT 类型,将发生异常。

退货: boolean - 相应的布尔值。

getNextMatchingNode(Node curNode)

public Node getNextMatchingNode(Node curNode)

参数:

范围类型描述
curNodeNode

退货: Node

getNextSibling()

public Node getNextSibling()

获取紧跟在该节点之后的节点。如果没有下一个节点,则返回 null。

退货: Node - 紧接此节点之后的节点。

getNodeType()

public int getNodeType()

退货NodeType.StructuredDocumentTag.

退货: 整数 -NodeType.StructuredDocumentTag .返回值是其中之一NodeType常数。

getParentNode()

public CompositeNode getParentNode()

获取此节点的直接父级。

如果一个节点刚刚被创建并且还没有被添加到树中,或者如果它已经被从树中移除,则父节点为空。

退货: CompositeNode - 此节点的直接父节点。

getPlaceholder()

public BuildingBlock getPlaceholder()

获取BuildingBlock包含应在此 SDT 运行内容为空时显示的占位符文本,关联的映射 XML 元素为空,如通过getXmlMapping()元素或isShowingPlaceholderText() / isShowingPlaceholderText(boolean)元素为真。可以为空,表示占位符不适用于此 Sdt。

退货: BuildingBlock - 这BuildingBlock包含应在此 SDT 运行内容为空时显示的占位符文本,关联的映射 XML 元素为空,如通过getXmlMapping()元素或isShowingPlaceholderText() / isShowingPlaceholderText(boolean)元素为真。

getPlaceholderName()

public String getPlaceholderName()

获取或设置名称BuildingBlock包含占位符文本。

具有此名称的 BuildingBlockBuildingBlock.getName() / BuildingBlock.setName(java.lang.String)必须出现在Document.getGlossaryDocument() / Document.setGlossaryDocument(com.aspose.words.GlossaryDocument)否则会出现 java.lang.IllegalStateException。

退货: java.lang.String - 相应的 java.lang.String 值。

getPreviousSibling()

public Node getPreviousSibling()

获取紧接在该节点之前的节点。如果前面没有节点,则返回 null。

退货: Node - 紧接在该节点之前的节点。

getRange()

public Range getRange()

返回一个Range表示包含在该节点中的文档部分的对象。

退货: Range - 一个Range表示包含在该节点中的文档部分的对象。

getSdtType()

public int getSdtType()

获取 this 的类型Structured document tag.

退货: int - 这个的类型Structured document tag .返回值是其中之一SdtType常数。

getStyle()

public Style getStyle()

获取结构化文档标签的样式。仅有的StyleType.CHARACTER风格或StyleType.PARAGRAPH可以设置链接字符样式的样式。

退货: Style - 结构化文档标签的样式。

getStyleName()

public String getStyleName()

获取应用于结构化文档标签的样式名称。

退货: java.lang.String - 应用于结构化文档标签的样式名称。

getTag()

public String getTag()

指定与当前 SDT 节点关联的标签。不能为空。标记是应用程序可以与 SDT 关联的任意字符串,以便在不提供可见友好名称的情况下识别它。

退货: java.lang.String - 相应的 java.lang.String 值。

getText()

public String getText()

获取此节点及其所有子节点的文本。

返回的字符串包括所有控制字符和特殊字符,如ControlChar.

退货: java.lang.字符串

getTitle()

public String getTitle()

指定与此关联的友好名称SDT.不能为空。

退货: java.lang.String - 相应的 java.lang.String 值。

getWordOpenXML()

public String getWordOpenXML()

获取一个字符串,该字符串表示包含在SaveFormat.FLAT_OPC格式。

退货: java.lang.String - 一个字符串,表示包含在SaveFormat.FLAT_OPC格式。

getXmlMapping()

public XmlMapping getXmlMapping()

获取一个对象,该对象表示此结构化文档标记到当前文档的自定义 XML 部分中的 XML 数据的映射。您可以使用XmlMapping.setMapping(com.aspose.words.CustomXmlPart, java.lang.String, java.lang.String)此对象的方法将结构化文档标记映射到 XML 数据。

退货: XmlMapping - 表示此结构化文档标记到当前文档的自定义 XML 部分中的 XML 数据的映射的对象。

hasChildNodes()

public boolean hasChildNodes()

如果此节点有任何子节点,则返回 true。

退货: boolean - 如果此节点有任何子节点则为真。

hashCode()

public native int hashCode()

退货: 整数

indexOf(Node child)

public int indexOf(Node child)

返回子节点数组中指定子节点的索引。如果在子节点中找不到该节点,则返回 -1。

参数:

范围类型描述
childNode

退货: 整数

insertAfter(Node newChild, Node refChild)

public Node insertAfter(Node newChild, Node refChild)

在指定的引用节点之后立即插入指定的节点。

如果 refChild 为 null,则在子节点列表的开头插入 newChild。

如果 newChild 已经在树中,则首先将其删除。

如果被插入的节点是从另一个文档创建的,你应该使用**M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)**将节点导入当前文档。然后可以将导入的节点插入到当前文档中。

参数:

范围类型描述
newChildNode要插入的节点。
refChildNode作为参考节点的节点。 newNode 放置在 refNode 之后。

退货: Node - 插入的节点。

insertBefore(Node newChild, Node refChild)

public Node insertBefore(Node newChild, Node refChild)

将指定节点插入到紧靠指定引用节点之前。

如果 refChild 为 null,则在子节点列表的末尾插入 newChild。

如果 newChild 已经在树中,则首先将其删除。

如果被插入的节点是从另一个文档创建的,你应该使用**M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)**将节点导入当前文档。然后可以将导入的节点插入到当前文档中。

参数:

范围类型描述
newChildNode要插入的节点。
refChildNode作为参考节点的节点。 newChild 放置在此节点之前。

退货: Node - 插入的节点。

isComposite()

public boolean isComposite()

返回 true,因为此节点可以有子节点。

退货: boolean - True 因为这个节点可以有子节点。

isRanged()

public boolean isRanged()

如果此实例是范围结构化文档标记,则返回 true。

退货: 布尔值

isShowingPlaceholderText()

public boolean isShowingPlaceholderText()

指定此内容是否SDT应被解释为包含占位符文本(与 SDT 中的常规文本内容相反)。

如果设置为 true,则在打开此文档时应恢复此状态(显示占位符文本)。

退货: boolean - 相应的布尔值。

isShowingPlaceholderText(boolean value)

public void isShowingPlaceholderText(boolean value)

指定此内容是否SDT应被解释为包含占位符文本(与 SDT 中的常规文本内容相反)。

如果设置为 true,则在打开此文档时应恢复此状态(显示占位符文本)。

参数:

范围类型描述
valueboolean对应的布尔值。

isTemporary()

public boolean isTemporary()

指定这是否SDT当其内容被修改时,应从 WordProcessingML 文档中删除。

退货: boolean - 相应的布尔值。

isTemporary(boolean value)

public void isTemporary(boolean value)

指定这是否SDT当其内容被修改时,应从 WordProcessingML 文档中删除。

参数:

范围类型描述
valueboolean对应的布尔值。

iterator()

public Iterator iterator()

为该节点的子节点上的每个样式迭代提供支持。

退货: java.util.迭代器

nextPreOrder(Node rootNode)

public Node nextPreOrder(Node rootNode)

根据前序树遍历算法获取下一个节点。

参数:

范围类型描述
rootNodeNode遍历的顶端节点(极限)。

退货: Node - 预定顺序中的下一个节点。如果到达根节点则为空。

nodeTypeToString(int nodeType)

public static String nodeTypeToString(int nodeType)

参数:

范围类型描述
nodeTypeint

退货: java.lang.字符串

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

prependChild(Node newChild)

public Node prependChild(Node newChild)

将指定节点添加到此节点的子节点列表的开头。

如果 newChild 已经在树中,则首先将其删除。

如果被插入的节点是从另一个文档创建的,你应该使用**M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)**将节点导入当前文档。然后可以将导入的节点插入到当前文档中。

参数:

范围类型描述
newChildNode要添加的节点。

退货: Node - 添加的节点。

previousPreOrder(Node rootNode)

public Node previousPreOrder(Node rootNode)

根据前序树遍历算法获取上一个节点。

参数:

范围类型描述
rootNodeNode遍历的顶端节点(极限)。

退货: Node 预购顺序中的前一个节点。如果到达根节点则为空。

remove()

public void remove()

从父级中移除自身。

removeAllChildren()

public void removeAllChildren()

移除当前节点的所有子节点。

removeChild(Node oldChild)

public Node removeChild(Node oldChild)

删除指定的子节点。

删除节点后,oldChild 的父级设置为 null。

参数:

范围类型描述
oldChildNode要删除的节点。

退货: Node - 删除的节点。

removeMoveRevisions()

public void removeMoveRevisions()

removeRunAttr(int key)

public void removeRunAttr(int key)

参数:

范围类型描述
keyint

removeSelfOnly()

public void removeSelfOnly()

仅删除此 SDT 节点本身,但将其内容保留在文档树中。

removeSmartTags()

public void removeSmartTags()

删除所有SmartTag当前节点的后代节点。此方法不会删除智能标记的内容。

selectNodes(String xpath)

public NodeList selectNodes(String xpath)

选择与 XPath 表达式匹配的节点列表。

目前仅支持带有元素名称的表达式。不支持使用属性名称的表达式。

参数:

范围类型描述
xpathjava.lang.StringXPath 表达式。

退货: NodeList - 匹配 XPath 查询的节点列表。

selectSingleNode(String xpath)

public Node selectSingleNode(String xpath)

选择与 XPath 表达式匹配的第一个节点。

目前仅支持带有元素名称的表达式。不支持使用属性名称的表达式。

参数:

范围类型描述
xpathjava.lang.StringXPath 表达式。

退货: Node - 与 XPath 查询匹配的第一个节点,如果未找到匹配节点,则为 null。

setAppearance(int value)

public void setAppearance(int value)

获取/设置结构化文档标签的外观。

参数:

范围类型描述
valueint对应的int值。该值必须是其中之一SdtAppearance常数。

setBuildingBlockCategory(String value)

public void setBuildingBlockCategory(String value)

为此指定构建块的类别SDT节点。不能为空。

访问此属性仅适用于SdtType.BUILDING_BLOCK_GALLERYSdtType.DOC_PART_OBJSDT 类型。它是只读的SDT文档部件类型。

对于所有其他 SDT 类型,将发生异常。

参数:

范围类型描述
valuejava.lang.String对应的java.lang.String值。

setBuildingBlockGallery(String value)

public void setBuildingBlockGallery(String value)

为此指定构建块的类型SDT.不能为空。

访问此属性仅适用于SdtType.BUILDING_BLOCK_GALLERYSdtType.DOC_PART_OBJSDT 类型。它是只读的SDT文档部件类型。

对于所有其他 SDT 类型,将发生异常。

参数:

范围类型描述
valuejava.lang.String对应的java.lang.String值。

setCalendarType(int value)

public void setCalendarType(int value)

为此指定日历的类型SDT .默认为SdtCalendarType.DEFAULT

访问此属性仅适用于SdtType.DATESDT 类型。

对于所有其他 SDT 类型,将发生异常。

参数:

范围类型描述
valueint对应的int值。该值必须是其中之一SdtCalendarType常数。

setChecked(boolean value)

public void setChecked(boolean value)

获取/设置复选框的当前状态SDT.此属性的默认值为 false。

访问此属性仅适用于SdtType.CHECKBOX SDT 类型。

对于所有其他 SDT 类型,将发生异常。

参数:

范围类型描述
valueboolean对应的布尔值。

setCheckedSymbol(int characterCode, String fontName)

public void setCheckedSymbol(int characterCode, String fontName)

设置用于表示复选框内容控件的选中状态的符号。

参数:

范围类型描述
characterCodeint指定符号的字符代码。
fontNamejava.lang.String包含符号的字体的名称。

访问此方法仅适用于SdtType.CHECKBOX SDT 类型。

对于所有其他 SDT 类型,将发生异常。|

setColor(Color value)

public void setColor(Color value)

设置结构化文档标签的颜色。

参数:

范围类型描述
valuejava.awt.Color结构化文档标签的颜色。

setCustomNodeId(int value)

public void setCustomNodeId(int value)

指定自定义节点标识符。

默认为零。

这个标识符可以任意设置和使用。例如,作为获取外部数据的密钥。

重要说明,指定的值不会保存到输出文件中,并且仅在节点生命周期内存在。

参数:

范围类型描述
valueint对应的int值。

setDateDisplayFormat(String value)

public void setDateDisplayFormat(String value)

表示日期显示格式的字符串。不能为空。英语(美国)的日期是“mm/dd/yyyy”

访问此属性仅适用于SdtType.DATESDT 类型。

对于所有其他 SDT 类型,将发生异常。

参数:

范围类型描述
valuejava.lang.String对应的java.lang.String值。

setDateDisplayLocale(int value)

public void setDateDisplayLocale(int value)

允许设置/获取在此显示的日期的语言格式SDT.

访问此属性仅适用于SdtType.DATESDT 类型。

对于所有其他 SDT 类型,将发生异常。

参数:

范围类型描述
valueint对应的int值。

setDateStorageFormat(int value)

public void setDateStorageFormat(int value)

获取/设置日期 SDT 的日期存储格式,当SDT绑定到文档数据存储中的 XML 节点。默认值为SdtDateStorageFormat.DATE_TIME

访问此属性仅适用于SdtType.DATESDT 类型。

对于所有其他 SDT 类型,将发生异常。

参数:

范围类型描述
valueint对应的int值。该值必须是其中之一SdtDateStorageFormat常数。

setFullDate(Date value)

public void setFullDate(Date value)

指定上次输入的完整日期和时间SDT.

访问此属性仅适用于SdtType.DATESDT 类型。

对于所有其他 SDT 类型,将发生异常。

参数:

范围类型描述
valuejava.util.Date对应的 java.util.Date 值。

setLockContentControl(boolean value)

public void setLockContentControl(boolean value)

当设置为 true 时,此属性将禁止用户删除此SDT.

参数:

范围类型描述
valueboolean对应的布尔值。

setLockContents(boolean value)

public void setLockContents(boolean value)

当设置为 true 时,此属性将禁止用户编辑此文件的内容SDT.

参数:

范围类型描述
valueboolean对应的布尔值。

setMultiline(boolean value)

public void setMultiline(boolean value)

指定这是否SDT允许多行文本。

访问此属性仅适用于SdtType.RICH_TEXTSdtType.PLAIN_TEXTSDT 类型。

对于所有其他 SDT 类型,将发生异常。

参数:

范围类型描述
valueboolean对应的布尔值。

setPlaceholderName(String value)

public void setPlaceholderName(String value)

获取或设置名称BuildingBlock包含占位符文本。

具有此名称的 BuildingBlockBuildingBlock.getName() / BuildingBlock.setName(java.lang.String)必须出现在Document.getGlossaryDocument() / Document.setGlossaryDocument(com.aspose.words.GlossaryDocument)否则会出现 java.lang.IllegalStateException。

参数:

范围类型描述
valuejava.lang.String对应的java.lang.String值。

setRunAttr(int key, Object value)

public void setRunAttr(int key, Object value)

参数:

范围类型描述
keyint
valuejava.lang.Object

setStyle(Style value)

public void setStyle(Style value)

设置结构化文档标签的样式。仅有的StyleType.CHARACTER风格或StyleType.PARAGRAPH可以设置链接字符样式的样式。

参数:

范围类型描述
valueStyle结构化文档标签的样式。

setStyleName(String value)

public void setStyleName(String value)

设置应用于结构化文档标签的样式名称。

参数:

范围类型描述
valuejava.lang.String应用于结构化文档标签的样式名称。

setTag(String value)

public void setTag(String value)

指定与当前 SDT 节点关联的标签。不能为空。标记是应用程序可以与 SDT 关联的任意字符串,以便在不提供可见友好名称的情况下识别它。

参数:

范围类型描述
valuejava.lang.String对应的java.lang.String值。

setTitle(String value)

public void setTitle(String value)

指定与此关联的友好名称SDT.不能为空。

参数:

范围类型描述
valuejava.lang.String对应的java.lang.String值。

setUncheckedSymbol(int characterCode, String fontName)

public void setUncheckedSymbol(int characterCode, String fontName)

设置用于表示复选框内容控件的未选中状态的符号。

参数:

范围类型描述
characterCodeint指定符号的字符代码。
fontNamejava.lang.String包含符号的字体的名称。

访问此方法仅适用于SdtType.CHECKBOX SDT 类型。

对于所有其他 SDT 类型,将发生异常。|

structuredDocumentTagNode()

public Node structuredDocumentTagNode()

返回实现此接口的 Node 对象。

退货: Node

toString()

public String toString()

退货: java.lang.字符串

toString(SaveOptions saveOptions)

public String toString(SaveOptions saveOptions)

使用指定的保存选项将节点的内容导出为字符串。

参数:

范围类型描述
saveOptionsSaveOptions指定控制节点保存方式的选项。

退货: java.lang.String - 指定格式的节点内容。

toString(int saveFormat)

public String toString(int saveFormat)

参数:

范围类型描述
saveFormatint

退货: java.lang.字符串

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

参数:

范围类型描述
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

参数:

范围类型描述
arg0long
arg1int