StructuredDocumentTagRangeStart

遗产： java.lang.Object, com.aspose.words.Node

所有已实现的接口： com.aspose.words.IStructuredDocumentTag, java.lang.Iterable

public class StructuredDocumentTagRangeStart extends Node implements IStructuredDocumentTag, Iterable

代表开始ranged接受多节内容的结构化文档标签。也可以看看StructuredDocumentTagRangeEnd.

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

可以是直系子女Body节点only.

构造器

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

方法

方法	描述
accept(DocumentVisitor visitor)
appendChild(Node newChild)	将指定节点添加到 stdContent 范围的末尾。
dd()
deepClone(boolean isCloneChildren)	创建节点的副本。
equals(Object arg0)
getAncestor(int ancestorType)
getAncestor(Class ancestorType)	获取指定对象类型的第一个祖先。
getChildNodes()	获取此范围开始节点和范围结束节点之间的所有节点。
getChildNodes(int nodeType, boolean isDeep)
getClass()
getColor()	获取结构化文档标签的颜色。
getCustomNodeId()	指定自定义节点标识符。
getDocument()	获取此节点所属的文档。
getId()	为此结构化文档标签指定一个唯一的只读持久数字 ID。
getLastChild()	获取 stdContent 范围中的最后一个子项。
getLevel()	获取此结构化文档标记范围开始出现在文档树中的级别。
getLockContentControl()	当设置为 true 时，此属性将禁止用户删除此结构化文档标记。
getLockContents()	当设置为 true 时，此属性将禁止用户编辑此结构化文档标记的内容。
getNextSibling()	获取紧跟在该节点之后的节点。
getNodeType()
getParentNode()	获取此节点的直接父级。
getPlaceholder()	获取BuildingBlock包含应在此结构化文档标记运行内容为空时显示的占位符文本，关联的映射 XML 元素为空，如通过getXmlMapping()元素或isShowingPlaceholderText() / isShowingPlaceholderText(boolean)元素为真。
getPlaceholderName()	获取或设置名称BuildingBlock包含占位符文本。
getPreviousSibling()	获取紧接在该节点之前的节点。
getRange()	返回一个Range表示包含在该节点中的文档部分的对象。
getRangeEnd()	如果 StructuredDocumentTag 是范围结构化文档标记，则指定范围结束。
getSdtType()	获取此结构化文档标签的类型。
getTag()	指定与当前结构化文档标签节点关联的标签。
getText()	获取此节点及其所有子节点的文本。
getTitle()	指定与此结构化文档标记关联的友好名称。
getWordOpenXML()	获取一个字符串，该字符串表示包含在SaveFormat.FLAT_OPC格式。
getXmlMapping()	获取一个对象，该对象表示此结构化文档标记范围到当前文档的自定义 XML 部分中的 XML 数据的映射。
hashCode()
isComposite()	如果此节点可以包含其他节点，则返回 true。
isRanged()
isShowingPlaceholderText()	指定此结构化文档标签的内容是否应解释为包含占位符文本（与结构化文档标签中的常规文本内容相对）。
isShowingPlaceholderText(boolean value)	指定此结构化文档标签的内容是否应解释为包含占位符文本（与结构化文档标签中的常规文本内容相对）。
iterator()	为该节点的子节点上的每个样式迭代提供支持。
nextPreOrder(Node rootNode)	根据前序树遍历算法获取下一个节点。
nodeTypeToString(int nodeType)
notify()
notifyAll()
previousPreOrder(Node rootNode)	根据前序树遍历算法获取上一个节点。
remove()	从父级中移除自身。
removeAllChildren()	删除此范围起始节点和范围结束节点之间的所有节点。
removeSelfOnly()	删除结构化文档标签的范围开始和适当的范围结束节点，但将其内容保留在文档树中。
setColor(Color value)	设置结构化文档标签的颜色。
setCustomNodeId(int value)	指定自定义节点标识符。
setLockContentControl(boolean value)	当设置为 true 时，此属性将禁止用户删除此结构化文档标记。
setLockContents(boolean value)	当设置为 true 时，此属性将禁止用户编辑此结构化文档标记的内容。
setPlaceholderName(String value)	获取或设置名称BuildingBlock包含占位符文本。
setTag(String value)	指定与当前结构化文档标签节点关联的标签。
setTitle(String value)	指定与此结构化文档标记关联的友好名称。
structuredDocumentTagNode()
toString()
toString(SaveOptions saveOptions)	使用指定的保存选项将节点的内容导出为字符串。
toString(int saveFormat)
wait()
wait(long arg0)
wait(long arg0, int arg1)

StructuredDocumentTagRangeStart(DocumentBase doc, int type)

public StructuredDocumentTagRangeStart(DocumentBase doc, int type)

初始化此类的新实例。

参数：

范围	类型	描述
doc	DocumentBase
type	int

accept(DocumentVisitor visitor)

public boolean accept(DocumentVisitor visitor)

接待来访者。

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

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

参数：

范围	类型	描述
visitor	DocumentVisitor

退货： 布尔值

appendChild(Node newChild)

public Node appendChild(Node newChild)

将指定节点添加到 stdContent 范围的末尾。

参数：

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

退货： Node - 添加的节点。

dd()

public void dd()

deepClone(boolean isCloneChildren)

public Node deepClone(boolean isCloneChildren)

创建节点的副本。

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

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

参数：

范围	类型	描述
isCloneChildren	boolean	True 递归克隆指定节点下的子树； false 仅克隆节点本身。

退货： Node - 克隆节点。

equals(Object arg0)

public boolean equals(Object arg0)

参数：

范围	类型	描述
arg0	java.lang.Object

退货： 布尔值

getAncestor(int ancestorType)

public CompositeNode getAncestor(int ancestorType)

参数：

范围	类型	描述
ancestorType	int

退货： CompositeNode

getAncestor(Class ancestorType)

public CompositeNode getAncestor(Class ancestorType)

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

参数：

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

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

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

getChildNodes()

public NodeCollection getChildNodes()

获取此范围开始节点和范围结束节点之间的所有节点。

退货： NodeCollection - 此范围起始节点和范围结束节点之间的所有节点。

getChildNodes(int nodeType, boolean isDeep)

public NodeCollection getChildNodes(int nodeType, boolean isDeep)

参数：

范围	类型	描述
nodeType	int
isDeep	boolean

退货： NodeCollection

getClass()

public final native Class<?> getClass()

退货： java.lang.Class

getColor()

public Color getColor()

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

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

getCustomNodeId()

public int getCustomNodeId()

指定自定义节点标识符。

默认为零。

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

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

退货： int - 相应的 int 值。

getDocument()

public DocumentBase getDocument()

获取此节点所属的文档。

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

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

getId()

public int getId()

为此结构化文档标签指定一个唯一的只读持久数字 ID。

Id 属性应遵循以下规则：

• 仅当整个文档被克隆时，文档才应保留结构化文档标签 IDDocument.deepClone().
• 期间DocumentBase.importNode(com.aspose.words.Node, boolean)如果 import 不会与目标文档中的其他结构化文档标签 ID 发生冲突，则应保留 ID。
• 如果多个结构化文档标签节点为 Id 属性指定了相同的十进制数值，则文档中的第一个结构化文档标签应保持此原始 Id，并且所有后续结构化文档标签节点应在文档被分配时分配新的标识符。加载。
• 在独立结构化文档标签期间**M:Aspose.Words.Markup.StructuredDocumentTag.Clone(System.Boolean,Aspose.Words.INodeCloningListener)**操作将为克隆的结构化文档标签节点生成新的唯一 ID。
• 如果在源文档中没有指定 Id，则结构化文档标签节点应在加载文档时分配一个新的唯一标识符。

退货： int - 相应的 int 值。

getLastChild()

public Node getLastChild()

获取 stdContent 范围中的最后一个子项。如果没有最后一个子节点，则返回 null。

退货： Node - stdContent 范围内的最后一个子项。

getLevel()

public int getLevel()

获取此结构化文档标记范围开始出现在文档树中的级别。

退货： int - 此结构化文档标记范围开始出现在文档树中的级别。返回值是其中之一MarkupLevel常数。

getLockContentControl()

public boolean getLockContentControl()

当设置为 true 时，此属性将禁止用户删除此结构化文档标记。

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

getLockContents()

public boolean getLockContents()

当设置为 true 时，此属性将禁止用户编辑此结构化文档标记的内容。

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

getNextSibling()

public Node getNextSibling()

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

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

getNodeType()

public int getNodeType()

获取此节点的类型。

退货： 整数

getParentNode()

public CompositeNode getParentNode()

获取此节点的直接父级。

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

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

getPlaceholder()

public BuildingBlock getPlaceholder()

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

退货： BuildingBlock - 这BuildingBlock包含应在此结构化文档标记运行内容为空时显示的占位符文本，关联的映射 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表示包含在该节点中的文档部分的对象。

getRangeEnd()

public StructuredDocumentTagRangeEnd getRangeEnd()

如果 StructuredDocumentTag 是范围结构化文档标记，则指定范围结束。否则返回 null。

退货： StructuredDocumentTagRangeEnd - 相应的StructuredDocumentTagRangeEnd价值。

getSdtType()

public int getSdtType()

获取此结构化文档标签的类型。

退货： int - 此结构化文档标签的类型。返回值是其中之一SdtType常数。

getTag()

public String getTag()

指定与当前结构化文档标签节点关联的标签。不能为空。标签是一个任意字符串，应用程序可以将其与结构化文档标签相关联，以便在不提供可见友好名称的情况下识别它。

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

getText()

public String getText()

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

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

退货： java.lang.字符串

getTitle()

public String getTitle()

指定与此结构化文档标记关联的友好名称。不能为空。

退货： 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 数据的映射的对象。

hashCode()

public native int hashCode()

退货： 整数

isComposite()

public boolean isComposite()

如果此节点可以包含其他节点，则返回 true。 (31110,6)

退货： boolean - 如果此节点可以包含其他节点则为真。

isRanged()

public boolean isRanged()

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

退货： 布尔值

isShowingPlaceholderText()

public boolean isShowingPlaceholderText()

指定此结构化文档标签的内容是否应解释为包含占位符文本（与结构化文档标签中的常规文本内容相对）。

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

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

isShowingPlaceholderText(boolean value)

public void isShowingPlaceholderText(boolean value)

指定此结构化文档标签的内容是否应解释为包含占位符文本（与结构化文档标签中的常规文本内容相对）。

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

参数：

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

iterator()

public Iterator iterator()

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

退货： java.util.迭代器

nextPreOrder(Node rootNode)

public Node nextPreOrder(Node rootNode)

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

参数：

范围	类型	描述
rootNode	Node	遍历的顶端节点（极限）。

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

nodeTypeToString(int nodeType)

public static String nodeTypeToString(int nodeType)

参数：

范围	类型	描述
nodeType	int

退货： java.lang.字符串

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

previousPreOrder(Node rootNode)

public Node previousPreOrder(Node rootNode)

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

参数：

范围	类型	描述
rootNode	Node	遍历的顶端节点（极限）。

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

remove()

public void remove()

从父级中移除自身。

removeAllChildren()

public void removeAllChildren()

删除此范围起始节点和范围结束节点之间的所有节点。

removeSelfOnly()

public void removeSelfOnly()

删除结构化文档标签的范围开始和适当的范围结束节点，但将其内容保留在文档树中。

setColor(Color value)

public void setColor(Color value)

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

参数：

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

setCustomNodeId(int value)

public void setCustomNodeId(int value)

指定自定义节点标识符。

默认为零。

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

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

参数：

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

setLockContentControl(boolean value)

public void setLockContentControl(boolean value)

当设置为 true 时，此属性将禁止用户删除此结构化文档标记。

参数：

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

setLockContents(boolean value)

public void setLockContents(boolean value)

当设置为 true 时，此属性将禁止用户编辑此结构化文档标记的内容。

参数：

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

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。

参数：

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

setTag(String value)

public void setTag(String value)

指定与当前结构化文档标签节点关联的标签。不能为空。标签是一个任意字符串，应用程序可以将其与结构化文档标签相关联，以便在不提供可见友好名称的情况下识别它。

参数：

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

setTitle(String value)

public void setTitle(String value)

指定与此结构化文档标记关联的友好名称。不能为空。

参数：

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

structuredDocumentTagNode()

public Node structuredDocumentTagNode()

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

退货： Node

toString()

public String toString()

退货： java.lang.字符串

toString(SaveOptions saveOptions)

public String toString(SaveOptions saveOptions)

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

参数：

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

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

toString(int saveFormat)

public String toString(int saveFormat)

参数：

范围	类型	描述
saveFormat	int

退货： java.lang.字符串

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

参数：

范围	类型	描述
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

参数：

范围	类型	描述
arg0	long
arg1	int