Footnote

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

public class Footnote extends InlineStory

表示脚注或尾注文本的容器。

要了解更多信息，请访问Working with Footnote and Endnote文档文章。

这Footnote类用于表示 Word 文档中的脚注和尾注。

Footnote是一个内联级节点，只能是Paragraph.

Footnote可以包含Paragraph和Table子节点。

构造器

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

方法

方法	描述
accept(DocumentVisitor visitor)	接待来访者。
appendChild(Node newChild)	将指定节点添加到此节点的子节点列表的末尾。
clearRunAttrs()
dd()
deepClone(boolean isCloneChildren)	创建节点的副本。
ensureMinimum()	如果最后一个孩子不是段落，则创建并附加一个空段落。
equals(Object arg0)
fetchInheritedRunAttr(int fontAttr)
getAncestor(int ancestorType)
getAncestor(Class ancestorType)	获取指定对象类型的第一个祖先。
getChild(int nodeType, int index, boolean isDeep)
getChildNodes()	获取此节点的所有直接子节点。
getChildNodes(int nodeType, boolean isDeep)
getClass()
getContainer()
getCount()	获取此节点的直接子节点数。
getCurrentNode()
getCustomNodeId()	指定自定义节点标识符。
getDirectRunAttr(int fontAttr)
getDocument()	获取此节点所属的文档。
getDocument_IInline()
getFirstChild()	获取节点的第一个子节点。
getFirstParagraph()	获取故事的第一段。
getFont()	提供对此对象的锚字符的字体格式的访问。
getFootnoteType()	返回一个值，该值指定这是脚注还是尾注。
getLastChild()	获取节点的最后一个子节点。
getLastParagraph()	获取故事的最后一段。
getNextMatchingNode(Node curNode)
getNextSibling()	获取紧跟在该节点之后的节点。
getNodeType()	退货NodeType.Footnote.
getParagraphs()	获取作为故事的直接子级的段落集合。
getParentNode()	获取此节点的直接父级。
getParentParagraph()	检索父级Paragraph这个节点的。
getParentParagraph_IInline()
getPreviousSibling()	获取紧接在该节点之前的节点。
getRange()	返回一个Range表示包含在该节点中的文档部分的对象。
getReferenceMark()	获取/设置要用于此脚注的自定义引用标记。
getStoryType()	退货StoryType.Footnotes或者StoryType.Endnotes.
getTables()	获取作为故事的直接子项的表的集合。
getText()	获取此节点及其所有子节点的文本。
hasChildNodes()	如果此节点有任何子节点，则返回 true。
hashCode()
indexOf(Node child)	返回子节点数组中指定子节点的索引。
insertAfter(Node newChild, Node refChild)	在指定的引用节点之后立即插入指定的节点。
insertBefore(Node newChild, Node refChild)	将指定节点插入到紧靠指定引用节点之前。
isAuto()	包含一个值，该值指定这是自动编号的脚注还是带有用户定义的自定义引用标记的脚注。
isAuto(boolean value)	包含一个值，该值指定这是自动编号的脚注还是带有用户定义的自定义引用标记的脚注。
isComposite()	返回 true，因为此节点可以有子节点。
isDeleteRevision()	如果启用更改跟踪时此对象在 Microsoft Word 中被删除，则返回 true。
isInsertRevision()	如果在启用更改跟踪时将此对象插入 Microsoft Word，则返回 true。
isMoveFromRevision()	退货true如果启用更改跟踪时此对象在 Microsoft Word 中被移动（删除）。
isMoveToRevision()	退货true如果启用更改跟踪时在 Microsoft Word 中移动（插入）此对象。
iterator()	为该节点的子节点上的每个样式迭代提供支持。
nextPreOrder(Node rootNode)	根据前序树遍历算法获取下一个节点。
nodeTypeToString(int nodeType)
notify()
notifyAll()
prependChild(Node newChild)	将指定节点添加到此节点的子节点列表的开头。
previousPreOrder(Node rootNode)	根据前序树遍历算法获取上一个节点。
remove()	从父级中移除自身。
removeAllChildren()	移除当前节点的所有子节点。
removeChild(Node oldChild)	删除指定的子节点。
removeMoveRevisions()
removeRunAttr(int key)
removeSmartTags()	删除所有SmartTag当前节点的后代节点。
selectNodes(String xpath)	选择与 XPath 表达式匹配的节点列表。
selectSingleNode(String xpath)	选择与 XPath 表达式匹配的第一个节点。
setCustomNodeId(int value)	指定自定义节点标识符。
setReferenceMark(String value)	获取/设置要用于此脚注的自定义引用标记。
setRunAttr(int fontAttr, Object value)
toString()
toString(SaveOptions saveOptions)	使用指定的保存选项将节点的内容导出为字符串。
toString(int saveFormat)
wait()
wait(long arg0)
wait(long arg0, int arg1)

Footnote(DocumentBase doc, int footnoteType)

public Footnote(DocumentBase doc, int footnoteType)

初始化此类的新实例。

参数：

范围	类型	描述
doc	DocumentBase
footnoteType	int

accept(DocumentVisitor visitor)

public boolean accept(DocumentVisitor visitor)

接待来访者。

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

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

参数：

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

退货： boolean - 如果所有节点都被访问，则为真；如果 DocumentVisitor 在访问所有节点之前停止操作，则返回 false。调用 DocumentVisitor.VisitFootnoteStart，然后为脚注的所有子节点调用 Accept，最后调用 DocumentVisitor.VisitFootnoteEnd。

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 - 添加的节点。

clearRunAttrs()

public void clearRunAttrs()

dd()

public void dd()

deepClone(boolean isCloneChildren)

public Node deepClone(boolean isCloneChildren)

创建节点的副本。

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

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

参数：

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

退货： Node - 克隆节点。

ensureMinimum()

public void ensureMinimum()

如果最后一个孩子不是段落，则创建并附加一个空段落。

equals(Object arg0)

public boolean equals(Object arg0)

参数：

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

退货： 布尔值

fetchInheritedRunAttr(int fontAttr)

public Object fetchInheritedRunAttr(int fontAttr)

参数：

范围	类型	描述
fontAttr	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，则祖先类型匹配。

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 值。

getDirectRunAttr(int fontAttr)

public Object getDirectRunAttr(int fontAttr)

参数：

范围	类型	描述
fontAttr	int

退货： java.lang.Object

getDocument()

public DocumentBase getDocument()

获取此节点所属的文档。

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

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

getDocument_IInline()

public DocumentBase getDocument_IInline()

退货： DocumentBase

getFirstChild()

public Node getFirstChild()

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

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

getFirstParagraph()

public Paragraph getFirstParagraph()

获取故事的第一段。

退货： Paragraph - 故事的第一段。

getFont()

public Font getFont()

提供对此对象的锚字符的字体格式的访问。

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

getFootnoteType()

public int getFootnoteType()

返回一个值，该值指定这是脚注还是尾注。

退货： int - 指定这是脚注还是尾注的值。返回值是其中之一FootnoteType常数。

getLastChild()

public Node getLastChild()

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

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

getLastParagraph()

public Paragraph getLastParagraph()

获取故事的最后一段。

退货： Paragraph - 故事的最后一段。

getNextMatchingNode(Node curNode)

public Node getNextMatchingNode(Node curNode)

参数：

范围	类型	描述
curNode	Node

退货： Node

getNextSibling()

public Node getNextSibling()

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

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

getNodeType()

public int getNodeType()

退货NodeType.Footnote.

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

getParagraphs()

public ParagraphCollection getParagraphs()

获取作为故事的直接子级的段落集合。

退货： ParagraphCollection - 故事的直接子段落的集合。

getParentNode()

public CompositeNode getParentNode()

获取此节点的直接父级。

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

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

getParentParagraph()

public Paragraph getParentParagraph()

检索父级Paragraph这个节点的。

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

getParentParagraph_IInline()

public Paragraph getParentParagraph_IInline()

退货： Paragraph

getPreviousSibling()

public Node getPreviousSibling()

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

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

getRange()

public Range getRange()

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

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

getReferenceMark()

public String getReferenceMark()

获取/设置要用于此脚注的自定义引用标记。默认值为empty string，表示使用自动编号的脚注。

如果此属性设置为empty string或为空，则isAuto() / isAuto(boolean)属性将自动设置为 true，如果设置为其他任何值则isAuto() / isAuto(boolean)将设置为假。

RTF 格式只能存储 1 个符号作为自定义参考标记，因此在导出时只会写入第一个符号，其他符号将被丢弃。

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

getStoryType()

public int getStoryType()

退货StoryType.Footnotes或者StoryType.Endnotes.

退货： 整数 -StoryType.Footnotes或者StoryType.Endnotes .返回值是其中之一StoryType常数。

getTables()

public TableCollection getTables()

获取作为故事的直接子项的表的集合。

退货： TableCollection 作为故事的直接子项的表的集合。

getText()

public String getText()

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

返回的字符串包括所有控制字符和特殊字符，如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 - 插入的节点。

isAuto()

public boolean isAuto()

包含一个值，该值指定这是自动编号的脚注还是带有用户定义的自定义引用标记的脚注。getReferenceMark() / setReferenceMark(java.lang.String)如果 IsAuto 设置为 false，则使用空字符串初始化。

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

isAuto(boolean value)

public void isAuto(boolean value)

包含一个值，该值指定这是自动编号的脚注还是带有用户定义的自定义引用标记的脚注。getReferenceMark() / setReferenceMark(java.lang.String)如果 IsAuto 设置为 false，则使用空字符串初始化。

参数：

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

isComposite()

public boolean isComposite()

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

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

isDeleteRevision()

public boolean isDeleteRevision()

如果启用更改跟踪时此对象在 Microsoft Word 中被删除，则返回 true。

退货： 布尔值 - 如果在启用更改跟踪的情况下在 Microsoft Word 中删除了此对象，则为 True。

isInsertRevision()

public boolean isInsertRevision()

如果在启用更改跟踪时将此对象插入 Microsoft Word，则返回 true。

退货： 布尔值 - 如果在启用更改跟踪的情况下将此对象插入到 Microsoft Word 中，则为 True。

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.迭代器

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()

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值。

setReferenceMark(String value)

public void setReferenceMark(String value)

获取/设置要用于此脚注的自定义引用标记。默认值为empty string，表示使用自动编号的脚注。

如果此属性设置为empty string或为空，则isAuto() / isAuto(boolean)属性将自动设置为 true，如果设置为其他任何值则isAuto() / isAuto(boolean)将设置为假。

RTF 格式只能存储 1 个符号作为自定义参考标记，因此在导出时只会写入第一个符号，其他符号将被丢弃。

参数：

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

setRunAttr(int fontAttr, Object value)

public void setRunAttr(int fontAttr, Object value)

参数：

范围	类型	描述
fontAttr	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