CommentRangeStart
遗产: java.lang.Object, com.aspose.words.Node
public class CommentRangeStart extends Node
表示具有与之关联的注释的文本区域的开始。
要了解更多信息,请访问Working with Comments文档文章。
要创建锚定到文本区域的评论,您需要创建一个Comment然后创建CommentRangeStart和CommentRangeEnd并将它们的标识符设置为相同Comment.getId()价值。
CommentRangeStart是一个内联级节点,只能是Paragraph.
构造器
构造函数 | 描述 |
---|---|
CommentRangeStart(DocumentBase doc, int id) | 初始化此类的新实例。 |
方法
CommentRangeStart(DocumentBase doc, int id)
public CommentRangeStart(DocumentBase doc, int id)
初始化此类的新实例。
什么时候CommentRangeStart已创建,它属于指定文档,但还不是文档的一部分,并且Node.getParentNode()一片空白。
附加一个CommentRangeStart在要插入注释的段落上使用 InsertAfter 或 InsertBefore 到文档。
参数:
范围 | 类型 | 描述 |
---|---|---|
doc | DocumentBase | 所有者文件。 |
id | int | 此对象链接到的注释标识符。 |
accept(DocumentVisitor visitor)
public boolean accept(DocumentVisitor visitor)
接待来访者。
来电DocumentVisitor.visitCommentRangeStart(com.aspose.words.CommentRangeStart).
有关更多信息,请参阅访问者设计模式。
参数:
范围 | 类型 | 描述 |
---|---|---|
visitor | DocumentVisitor | 将访问节点的访问者。 |
退货: boolean - 如果访问者请求停止枚举,则为 False。
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,则祖先类型匹配。
getClass()
public final native Class<?> getClass()
退货: java.lang.Class
getCustomNodeId()
public int getCustomNodeId()
指定自定义节点标识符。
默认为零。
这个标识符可以任意设置和使用。例如,作为获取外部数据的密钥。
重要说明,指定的值不会保存到输出文件中,并且仅在节点生命周期内存在。
退货: int - 相应的 int 值。
getDisplacedByCustomXml()
public int getDisplacedByCustomXml()
退货: 整数
getDocument()
public DocumentBase getDocument()
获取此节点所属的文档。
该节点始终属于一个文档,即使它刚刚创建并且尚未添加到树中,或者如果它已从树中删除也是如此。
退货: DocumentBase - 该节点所属的文档。
getId()
public int getId()
指定此区域链接到的评论的标识符。
退货: int - 相应的 int 值。
getIdInternal()
public int getIdInternal()
退货: 整数
getNextSibling()
public Node getNextSibling()
获取紧跟在该节点之后的节点。如果没有下一个节点,则返回 null。
退货: Node - 紧接此节点之后的节点。
getNodeType()
public int getNodeType()
退货NodeType.COMMENT_RANGE_START.
退货: 整数 -{NodeType.COMMENT_RANGE_START .返回值是其中之一NodeType常数。
getParentIdInternal()
public int getParentIdInternal()
退货: 整数
getParentNode()
public CompositeNode getParentNode()
获取此节点的直接父级。
如果一个节点刚刚被创建并且还没有被添加到树中,或者如果它已经被从树中移除,则父节点为空。
退货: CompositeNode - 此节点的直接父节点。
getPreviousSibling()
public Node getPreviousSibling()
获取紧接在该节点之前的节点。如果前面没有节点,则返回 null。
退货: Node - 紧接在该节点之前的节点。
getRange()
public Range getRange()
返回一个Range表示包含在该节点中的文档部分的对象。
退货: Range - 一个Range表示包含在该节点中的文档部分的对象。
getText()
public String getText()
获取此节点及其所有子节点的文本。
返回的字符串包括所有控制字符和特殊字符,如ControlChar.
退货: java.lang.字符串
hashCode()
public native int hashCode()
退货: 整数
isComposite()
public boolean isComposite()
如果此节点可以包含其他节点,则返回 true。 (31110,6)
退货: boolean - 如果此节点可以包含其他节点则为真。
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()
从父级中移除自身。
setCustomNodeId(int value)
public void setCustomNodeId(int value)
指定自定义节点标识符。
默认为零。
这个标识符可以任意设置和使用。例如,作为获取外部数据的密钥。
重要说明,指定的值不会保存到输出文件中,并且仅在节点生命周期内存在。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 对应的int值。 |
setDisplacedByCustomXml(int value)
public void setDisplacedByCustomXml(int value)
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int |
setId(int value)
public void setId(int value)
指定此区域链接到的评论的标识符。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 对应的int值。 |
setIdInternal(int value)
public void setIdInternal(int value)
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int |
setParentIdInternal(int value)
public void setParentIdInternal(int value)
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int |
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 |