Paragraph
遗产: java.lang.Object, com.aspose.words.Node, com.aspose.words.CompositeNode
public class Paragraph extends CompositeNode
代表一段文字。
要了解更多信息,请访问Working with Paragraphs文档文章。
Paragraph是块级节点,可以是派生自的类的子节点Story或者InlineStory.
Paragraph可以包含任意数量的内联级节点和书签。
段落中可能出现的子节点的完整列表包括BookmarkStart, BookmarkEnd, FieldStart, FieldSeparator, FieldEnd, FormField, Comment, Footnote, Run, SpecialChar, Shape, GroupShape, SmartTag.
Microsoft Word 中的有效段落始终以段落分隔符结尾,最小有效段落仅由段落分隔符组成。这Paragraph类自动在末尾附加适当的段落分隔符,并且该字符不是子节点的一部分Paragraph 因此Paragraph可以为空。
不包含段落结尾ControlChar.PARAGRAPH_BREAK或单元格结尾ControlChar.CELL段落文本中的字符,因为在 Microsoft Word 中打开文档时,这可能会使段落无效。
构造器
构造函数 | 描述 |
---|---|
Paragraph(DocumentBase doc) | 初始化一个新的实例Paragraph班级。 |
方法
Paragraph(DocumentBase doc)
public Paragraph(DocumentBase doc)
初始化一个新的实例Paragraph班级。
什么时候Paragraph已创建,它属于指定文档,但还不是文档的一部分,并且ParentNode一片空白。
追加Paragraph到文档,在要插入段落的故事上使用 InsertAfter 或 InsertBefore。
参数:
范围 | 类型 | 描述 |
---|---|---|
doc | DocumentBase | 所有者文件。 |
accept(DocumentVisitor visitor)
public boolean accept(DocumentVisitor visitor)
接待来访者。
枚举此节点及其所有子节点。每个节点调用 DocumentVisitor 上的相应方法。
有关更多信息,请参阅访问者设计模式。
参数:
范围 | 类型 | 描述 |
---|---|---|
visitor | DocumentVisitor | 将访问节点的访问者。 |
退货: boolean - 如果所有节点都被访问,则为真;如果 DocumentVisitor 在访问所有节点之前停止操作,则返回 false。调用 DocumentVisitor.VisitParagraphStart,然后为段落的所有子节点调用 Accept,最后调用 DocumentVisitor.VisitParagraphEnd。
appendChild(Node newChild)
public Node appendChild(Node newChild)
将指定节点添加到此节点的子节点列表的末尾。
如果 newChild 已经在树中,则首先将其删除。
如果被插入的节点是从另一个文档创建的,你应该使用**M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)**将节点导入当前文档。然后可以将导入的节点插入到当前文档中。
参数:
范围 | 类型 | 描述 |
---|---|---|
newChild | Node | 要添加的节点。 |
退货: Node - 添加的节点。
appendField(int fieldType, boolean updateField)
public Field appendField(int fieldType, boolean updateField)
参数:
范围 | 类型 | 描述 |
---|---|---|
fieldType | int | |
updateField | boolean |
退货: Field
appendField(String fieldCode)
public Field appendField(String fieldCode)
将 Word 字段附加到此段落。向该段落附加一个字段。
参数:
范围 | 类型 | 描述 |
---|---|---|
fieldCode | java.lang.String | 要追加的字段代码(不带花括号)。 |
appendField(String fieldCode, String fieldValue)
public Field appendField(String fieldCode, String fieldValue)
将 Word 字段附加到此段落。向该段落附加一个字段。
参数:
范围 | 类型 | 描述 |
---|---|---|
fieldCode | java.lang.String | 要追加的字段代码(不带花括号)。 |
fieldValue | java.lang.String | 要附加的字段值。为没有值的字段传递 null。 |
clearParaAttrs()
public void clearParaAttrs()
clearRunAttrs()
public void clearRunAttrs()
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 |
退货: 布尔值
fetchInheritedParaAttr(int key)
public Object fetchInheritedParaAttr(int key)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int |
退货: java.lang.Object
fetchInheritedRunAttr(int key)
public Object fetchInheritedRunAttr(int key)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int |
退货: java.lang.Object
fetchParaAttr(int key)
public Object fetchParaAttr(int key)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int |
退货: 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,则祖先类型匹配。
getBreakIsStyleSeparator()
public boolean getBreakIsStyleSeparator()
如果此段落分隔符是样式分隔符,则为真。样式分隔符允许一个段落由具有不同段落样式的部分组成。
退货: boolean - 相应的布尔值。
getChild(int nodeType, int index, boolean isDeep)
public Node getChild(int nodeType, int index, boolean isDeep)
参数:
范围 | 类型 | 描述 |
---|---|---|
nodeType | int | |
index | int | |
isDeep | boolean |
退货: Node
getChildNodes()
public NodeCollection getChildNodes()
获取此节点的所有直接子节点。
笔记,getChildNodes()相当于调用 GetChildNodes(NodeType.Any, false) 并在每次访问时创建并返回一个新集合。
如果没有子节点,则此属性返回一个空集合。
退货: 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
getContainer()
public CompositeNode getContainer()
退货: CompositeNode
getCount()
public int getCount()
获取此节点的直接子节点数。
退货: int - 此节点的直接子节点数。
getCurrentNode()
public Node getCurrentNode()
退货: Node
getCustomNodeId()
public int getCustomNodeId()
指定自定义节点标识符。
默认为零。
这个标识符可以任意设置和使用。例如,作为获取外部数据的密钥。
重要说明,指定的值不会保存到输出文件中,并且仅在节点生命周期内存在。
退货: int - 相应的 int 值。
getDirectParaAttr(int key)
public Object getDirectParaAttr(int key)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int |
退货: java.lang.Object
getDirectParaAttr(int key, int revisionsView)
public Object getDirectParaAttr(int key, int revisionsView)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int | |
revisionsView | int |
退货: java.lang.Object
getDirectRunAttr(int key)
public Object getDirectRunAttr(int key)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int |
退货: java.lang.Object
getDocument()
public DocumentBase getDocument()
获取此节点所属的文档。
该节点始终属于一个文档,即使它刚刚创建并且尚未添加到树中,或者如果它已从树中删除也是如此。
退货: DocumentBase - 该节点所属的文档。
getEffectiveTabStops()
public TabStop[] getEffectiveTabStops()
返回应用于此段落的所有制表位的数组,包括由样式或列表间接应用的。
退货: com.aspose.words.TabStop[]
getFirstChild()
public Node getFirstChild()
获取节点的第一个子节点。如果没有第一个子节点,则返回 null。
退货: Node - 节点的第一个孩子。
getFrameFormat()
public FrameFormat getFrameFormat()
提供对段落格式属性的访问。
退货: FrameFormat - 相应的FrameFormat价值。
getLastChild()
public Node getLastChild()
获取节点的最后一个子节点。如果没有最后一个子节点,则返回 null。
退货: Node - 节点的最后一个孩子。
getListFormat()
public ListFormat getListFormat()
提供对段落的列表格式属性的访问。
退货: ListFormat - 相应的ListFormat价值。
getListLabel()
public ListLabel getListLabel()
得到一个getListLabel()提供对本段列表编号值和格式的访问的对象。
退货: ListLabel - 一个getListLabel()提供对本段列表编号值和格式的访问的对象。
getNextMatchingNode(Node curNode)
public Node getNextMatchingNode(Node curNode)
参数:
范围 | 类型 | 描述 |
---|---|---|
curNode | Node |
退货: Node
getNextSibling()
public Node getNextSibling()
获取紧跟在该节点之后的节点。如果没有下一个节点,则返回 null。
退货: Node - 紧接此节点之后的节点。
getNodeType()
public int getNodeType()
退货NodeType.Paragraph.
退货: 整数 -NodeType.Paragraph .返回值是其中之一NodeType常数。
getParagraphBreakFont()
public Font getParagraphBreakFont()
提供对段落分隔符的字体格式的访问。
getParagraphFormat()
public ParagraphFormat getParagraphFormat()
提供对段落格式属性的访问。
退货: ParagraphFormat - 相应的ParagraphFormat价值。
getParentNode()
public CompositeNode getParentNode()
获取此节点的直接父级。
如果一个节点刚刚被创建并且还没有被添加到树中,或者如果它已经被从树中移除,则父节点为空。
退货: CompositeNode - 此节点的直接父节点。
getParentSection()
public Section getParentSection()
检索父级Section的段落。
getParentStory()
public Story getParentStory()
检索父节级别的故事,可以是Body或者HeaderFooter.
getPreviousSibling()
public Node getPreviousSibling()
获取紧接在该节点之前的节点。如果前面没有节点,则返回 null。
退货: Node - 紧接在该节点之前的节点。
getRange()
public Range getRange()
返回一个Range表示包含在该节点中的文档部分的对象。
退货: Range - 一个Range表示包含在该节点中的文档部分的对象。
getRuns()
public RunCollection getRuns()
提供对段落内文本片段的类型化集合的访问。
退货: RunCollection - 相应的RunCollection价值。
getText()
public String getText()
获取此段落的文本,包括段落结束字符。
连接所有子节点的文本并附加段落字符的结尾,如下所示:
- 如果该段是最后一段Body, 然后ControlChar.SECTION_BREAK(\x000c) 被附加。
- 如果该段是最后一段Cell, 然后ControlChar.CELL(\x0007) 被附加。
- 对于所有其他段落ControlChar.PARAGRAPH_BREAK(\r) 被附加。
返回的字符串包括所有控制字符和特殊字符,如ControlChar.
退货: java.lang.字符串
hasChildNodes()
public boolean hasChildNodes()
如果此节点有任何子节点,则返回 true。
退货: boolean - 如果此节点有任何子节点则为真。
hashCode()
public native int hashCode()
退货: 整数
indexOf(Node child)
public int indexOf(Node child)
返回子节点数组中指定子节点的索引。如果在子节点中找不到该节点,则返回 -1。
参数:
范围 | 类型 | 描述 |
---|---|---|
child | Node |
退货: 整数
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)**将节点导入当前文档。然后可以将导入的节点插入到当前文档中。
参数:
范围 | 类型 | 描述 |
---|---|---|
newChild | Node | 要插入的节点。 |
refChild | Node | 作为参考节点的节点。 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)**将节点导入当前文档。然后可以将导入的节点插入到当前文档中。
参数:
范围 | 类型 | 描述 |
---|---|---|
newChild | Node | 要插入的节点。 |
refChild | Node | 作为参考节点的节点。 newChild 放置在此节点之前。 |
退货: Node - 插入的节点。
insertField(int fieldType, boolean updateField, Node refNode, boolean isAfter)
public Field insertField(int fieldType, boolean updateField, Node refNode, boolean isAfter)
参数:
范围 | 类型 | 描述 |
---|---|---|
fieldType | int | |
updateField | boolean | |
refNode | Node | |
isAfter | boolean |
退货: Field
insertField(String fieldCode, Node refNode, boolean isAfter)
public Field insertField(String fieldCode, Node refNode, boolean isAfter)
在此段落中插入一个 Word 域。在此段落中插入一个字段。
参数:
范围 | 类型 | 描述 |
---|---|---|
fieldCode | java.lang.String | 要插入的域代码(不带花括号)。 |
refNode | Node | 此段落内的引用节点(如果 refNode 为空,则附加到段落的末尾)。 |
isAfter | boolean | 是在引用节点之后还是之前插入字段。 |
insertField(String fieldCode, String fieldValue, Node refNode, boolean isAfter)
public Field insertField(String fieldCode, String fieldValue, Node refNode, boolean isAfter)
在此段落中插入一个 Word 域。在此段落中插入一个字段。
参数:
范围 | 类型 | 描述 |
---|---|---|
fieldCode | java.lang.String | 要插入的域代码(不带花括号)。 |
fieldValue | java.lang.String | 要插入的字段值。为没有值的字段传递 null。 |
refNode | Node | 此段落内的引用节点(如果 refNode 为空,则附加到段落的末尾)。 |
isAfter | boolean | 是在引用节点之后还是之前插入字段。 |
isComposite()
public boolean isComposite()
返回 true,因为此节点可以有子节点。
退货: boolean - True 因为这个节点可以有子节点。
isDeleteRevision()
public boolean isDeleteRevision()
如果启用更改跟踪时此对象在 Microsoft Word 中被删除,则返回 true。
退货: 布尔值 - 如果在启用更改跟踪的情况下在 Microsoft Word 中删除了此对象,则为 True。
isEndOfCell()
public boolean isEndOfCell()
如果这段是最后一段则为真Cell;否则为假。
退货: boolean - 相应的布尔值。
isEndOfDocument()
public boolean isEndOfDocument()
如果此段是文档最后一节的最后一段,则为真。
退货: boolean - 相应的布尔值。
isEndOfHeaderFooter()
public boolean isEndOfHeaderFooter()
如果该段是该段中的最后一段,则为真HeaderFooter(正文故事)一个Section;否则为假。
退货: boolean - 相应的布尔值。
isEndOfSection()
public boolean isEndOfSection()
如果该段是该段中的最后一段,则为真Body(正文故事)一个Section;否则为假。
退货: boolean - 相应的布尔值。
isFormatRevision()
public boolean isFormatRevision()
如果在启用更改跟踪的情况下在 Microsoft Word 中更改了对象的格式,则返回 true。
退货: 布尔值 - 如果在启用更改跟踪的情况下在 Microsoft Word 中更改了对象的格式,则为 True。
isInCell()
public boolean isInCell()
如果此段落是的直接子项,则为真Cell;否则为假。
退货: boolean - 相应的布尔值。
isInsertRevision()
public boolean isInsertRevision()
如果在启用更改跟踪时将此对象插入 Microsoft Word,则返回 true。
退货: 布尔值 - 如果在启用更改跟踪的情况下将此对象插入到 Microsoft Word 中,则为 True。
isListItem()
public boolean isListItem()
当段落是原始修订版中的项目符号列表或编号列表中的项目时为真。
退货: boolean - 相应的布尔值。
isMoveFromRevision()
public boolean isMoveFromRevision()
退货true如果启用更改跟踪时此对象在 Microsoft Word 中被移动(删除)。
退货: 布尔值 -true如果启用更改跟踪时此对象在 Microsoft Word 中被移动(删除)。
isMoveToRevision()
public boolean isMoveToRevision()
退货true如果启用更改跟踪时在 Microsoft Word 中移动(插入)此对象。
退货: 布尔值 -true如果启用更改跟踪时在 Microsoft Word 中移动(插入)此对象。
iterator()
public Iterator iterator()
为该节点的子节点上的每个样式迭代提供支持。
退货: java.util.迭代器
joinRunsWithSameFormatting()
public int joinRunsWithSameFormatting()
加入段落中具有相同格式的运行。
退货: int - 执行的连接数。什么时候N相邻的运行正在被加入,它们算作N - 1加入。
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()
prependChild(Node newChild)
public Node prependChild(Node newChild)
将指定节点添加到此节点的子节点列表的开头。
如果 newChild 已经在树中,则首先将其删除。
如果被插入的节点是从另一个文档创建的,你应该使用**M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)**将节点导入当前文档。然后可以将导入的节点插入到当前文档中。
参数:
范围 | 类型 | 描述 |
---|---|---|
newChild | Node | 要添加的节点。 |
退货: Node - 添加的节点。
previousPreOrder(Node rootNode)
public Node previousPreOrder(Node rootNode)
根据前序树遍历算法获取上一个节点。
参数:
范围 | 类型 | 描述 |
---|---|---|
rootNode | Node | 遍历的顶端节点(极限)。 |
退货: Node 预购顺序中的前一个节点。如果到达根节点则为空。
remove()
public void remove()
从父级中移除自身。
removeAllChildren()
public void removeAllChildren()
移除当前节点的所有子节点。
removeChild(Node oldChild)
public Node removeChild(Node oldChild)
删除指定的子节点。
删除节点后,oldChild 的父级设置为 null。
参数:
范围 | 类型 | 描述 |
---|---|---|
oldChild | Node | 要删除的节点。 |
退货: Node - 删除的节点。
removeMoveRevisions()
public void removeMoveRevisions()
removeParaAttr(int key)
public void removeParaAttr(int key)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int |
removeRunAttr(int key)
public void removeRunAttr(int key)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int |
removeSmartTags()
public void removeSmartTags()
删除所有SmartTag当前节点的后代节点。此方法不会删除智能标记的内容。
selectNodes(String xpath)
public NodeList selectNodes(String xpath)
选择与 XPath 表达式匹配的节点列表。
目前仅支持带有元素名称的表达式。不支持使用属性名称的表达式。
参数:
范围 | 类型 | 描述 |
---|---|---|
xpath | java.lang.String | XPath 表达式。 |
退货: NodeList - 匹配 XPath 查询的节点列表。
selectSingleNode(String xpath)
public Node selectSingleNode(String xpath)
选择与 XPath 表达式匹配的第一个节点。
目前仅支持带有元素名称的表达式。不支持使用属性名称的表达式。
参数:
范围 | 类型 | 描述 |
---|---|---|
xpath | java.lang.String | XPath 表达式。 |
退货: Node - 与 XPath 查询匹配的第一个节点,如果未找到匹配节点,则为 null。
setCustomNodeId(int value)
public void setCustomNodeId(int value)
指定自定义节点标识符。
默认为零。
这个标识符可以任意设置和使用。例如,作为获取外部数据的密钥。
重要说明,指定的值不会保存到输出文件中,并且仅在节点生命周期内存在。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 对应的int值。 |
setParaAttr(int key, Object value)
public void setParaAttr(int key, Object value)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int | |
value | java.lang.Object |
setRunAttr(int key, Object value)
public void setRunAttr(int key, Object value)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int | |
value | java.lang.Object |
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 |