Document

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

public class Document extends DocumentBase

表示 Word 文档。

要了解更多信息,请访问Working with Document文档文章。

Document是 Aspose.Words 库中的核心对象。

以任何方式加载现有文档LoadFormat格式,将文件名或流传递到其中一个Document构造函数。要创建空白文档,请调用不带参数的构造函数。

使用 Save 方法重载之一将文档保存在任何SaveFormat格式。

将文档页面直接绘制到Graphics对象使用renderToScale(int, java.awt.Graphics2D, float, float, float)或者renderToSize(int, java.awt.Graphics2D, float, float, float, float)方法。

要打印文档,请使用其中一种print(java.lang.String)方法。

getMailMerge()是 Aspose.Words 的报告引擎,允许使用来自各种数据源的数据快速轻松地填充在 Microsoft Word 中设计的报告。数据可以来自 java.sql.ResultSet 或值数组。MailMerge将检查在数据源中找到的记录,并根据需要将它们插入到文档中的邮件合并字段中。

Document存储文档范围的信息,例如DocumentBase.getStyles(), getBuiltInDocumentProperties(), getCustomDocumentProperties()、列表和宏。这些对象中的大多数都可以通过相应的属性访问Document.

Document是包含文档所有其他节点的树的根节点。树是一种复合设计模式,在许多方面类似于 XmlDocument。可以通过编程方式自由操作文档的内容:

考虑使用DocumentBuilder这简化了以编程方式创建或填充文档树的任务。

Document只能包含Section对象。

在 Microsoft Word 中,一份有效的文档需要至少有一个节。

构造器

构造函数描述
Document()创建或加载文档。
Document(String fileName)从文件中打开现有文档。
Document(String fileName, LoadOptions loadOptions)从文件中打开现有文档。
Document(InputStream stream)初始化此类的新实例。
Document(InputStream stream, LoadOptions loadOptions)初始化此类的新实例。

方法

方法描述
accept(DocumentVisitor visitor)接待来访者。
acceptAllRevisions()接受文档中的所有修订。
add(Shape watermark)
appendChild(Node newChild)将指定节点添加到此节点的子节点列表的末尾。
appendDocument(Document srcDoc, int importFormatMode)
appendDocument(Document srcDoc, int importFormatMode, ImportFormatOptions importFormatOptions)
cleanup()从文档中清除未使用的样式和列表。
cleanup(CleanupOptions options)根据给定的内容从文档中清除未使用的样式和列表CleanupOptions.
clearSectionAttrs()
compare(Document document, String author, Date dateTime)将此文档与另一个文档进行比较,以编辑和格式修订的数量产生变化Revision.
compare(Document document, String author, Date dateTime, CompareOptions options)将此文档与另一个文档进行比较,产生一些编辑和格式修订的变化Revision.
copyStylesFromTemplate(Document template)将指定模板中的样式复制到文档中。
copyStylesFromTemplate(String template)将指定模板中的样式复制到文档中。
dd()
deepClone()执行深拷贝Document.
deepClone(boolean isCloneChildren)创建节点的副本。
ensureMinimum()如果文档不包含任何部分,则创建一个包含一个段落的部分。
equals(Object arg0)
expandTableStylesToDirectFormatting()将表格样式中指定的格式转换为文档中表格的直接格式。
extractPages(int index, int count)返回Document表示指定页面范围的对象。
fetchInheritedSectionAttr(int key)
fetchSectionAttr(int key)
get()
getAncestor(int ancestorType)
getAncestor(Class ancestorType)获取指定对象类型的第一个祖先。
getAttachedTemplate()获取附加到文档的模板的完整路径。
getAutomaticallyUpdateStyles()获取一个标志,指示每次在 MS Word 中打开文档时是否更新文档中的样式以匹配附加模板中的样式。
getBackgroundShape()获取文档的背景形状。
getBuiltInDocumentProperties()返回一个集合,该集合表示文档的所有内置文档属性。
getChild(int nodeType, int index, boolean isDeep)
getChildNodes()获取此节点的所有直接子节点。
getChildNodes(int nodeType, boolean isDeep)
getClass()
getCompatibilityOptions()提供对文档兼容性选项的访问(即,在Compatibility的选项卡OptionsWord 中的对话框)。
getCompliance()获取根据加载的文档内容确定的 OOXML 合规性版本。
getContainer()
getCount()获取此节点的直接子节点数。
getCurrentNode()
getCustomDocumentProperties()返回一个集合,该集合表示文档的所有自定义文档属性。
getCustomNodeId()指定自定义节点标识符。
getCustomXmlParts()获取自定义 XML 数据存储部件的集合。
getDefaultTabStop()获取默认制表位之间的间隔(以磅为单位)。
getDigitalSignatures()获取此文档的数字签名集合及其验证结果。
getDirectSectionAttr(int key)
getDocument()
getEndnoteOptions()提供控制本文档中尾注编号和位置的选项。
getFieldOptions()得到一个FieldOptions表示控制文档中字段处理的选项的对象。
getFirstChild()获取节点的第一个子节点。
getFirstSection()获取文档中的第一部分。
getFontInfos()提供对本文档中使用的字体属性的访问。
getFontSettings()获取文档字体设置。
getFootnoteOptions()提供控制本文档中脚注编号和位置的选项。
getFrameset()返回一个getFrameset()例如,如果此文档代表一个框架页面。
getGlossaryDocument()获取此文档或模板中的词汇表文档。
getGrammarChecked()退货true如果文档已经过语法检查。
getHyphenationOptions()提供对文档断字选项的访问。
getLastChild()获取节点的最后一个子节点。
getLastSection()获取文档中的最后一节。
getLayoutOptions()得到一个LayoutOptions表示控制此文档布局过程的选项的对象。
getLists()提供对文档中使用的列表格式的访问。
getMailMerge()返回一个MailMerge表示文档的邮件合并功能的对象。
getMailMergeSettings()获取包含文档的所有邮件合并信息的对象。
getNextMatchingNode(Node curNode)
getNextSibling()获取紧跟在该节点之后的节点。
getNodeChangingCallback()在文档中插入或删除节点时调用。
getNodeType()退货NodeType.Document.
getOriginalFileName()获取文档的原始文件名。
getOriginalLoadFormat()获取加载到此对象中的原始文档的格式。
getPackageCustomParts()获取使用“未知关系”链接到 OOXML 包的自定义部件(任意内容)的集合。
getPageColor()获取文档的页面颜色。
getPageCount()获取根据最近的页面布局操作计算的文档中的页数。
getPageInfo(int pageIndex)获取可能对打印或呈现有用的页面大小、方向和其他有关页面的信息。
getParentNode()获取此节点的直接父级。
getPreviousSibling()获取紧接在该节点之前的节点。
getProtectionType()获取当前活动的文档保护类型。
getRange()返回一个Range表示包含在该节点中的文档部分的对象。
getRemovePersonalInformation()获取一个标志,指示 Microsoft Word 将在保存文档时从注释、修订和文档属性中删除所有用户信息。
getResourceLoadingCallback()允许控制外部资源的加载方式。
getRevisions()获取此文档中存在的修订(跟踪更改)的集合。
getRevisionsView()获取一个值,该值指示是使用文档的原始版本还是修订版本。
getSections()返回代表文档中所有部分的集合。
getShadeFormData()指定是否打开表单域的灰色底纹。
getShowGrammaticalErrors()指定是否在此文档中显示语法错误。
getShowSpellingErrors()指定是否在此文档中显示拼写错误。
getSpellingChecked()退货true如果文档已经过拼写检查。
getStyles()返回文档中定义的样式集合。
getText()获取此节点及其所有子节点的文本。
getTheme()获取getTheme()本文档的对象。
getTrackRevisions()True在 Microsoft Word 中编辑此文档时是否跟踪更改。
getVariables()返回添加到文档或模板的变量集合。
getVbaProject()得到一个getVbaProject() / setVbaProject(com.aspose.words.VbaProject).
getVersionsCount()获取存储在 DOC 文档中的文档版本数。
getViewOptions()提供选项以控制文档在 Microsoft Word 中的显示方式。
getWarningCallback()当检测到可能导致数据或格式保真度丢失的问题时,在各种文档处理过程中调用。
getWatermark()提供对文档水印的访问。
getWebExtensionTaskPanes()返回表示任务窗格加载项列表的集合。
getWriteProtection()提供对文档写保护选项的访问。
hasChildNodes()如果此节点有任何子节点,则返回 true。
hasMacros()退货true如果文档有 VBA 项目(宏)。
hasRevisions()退货true如果文档有任何跟踪更改。
hashCode()
importNode(Node srcNode, boolean isImportChildren)将节点从另一个文档导入到当前文档。
importNode(Node srcNode, boolean isImportChildren, int importFormatMode)
indexOf(Node child)返回子节点数组中指定子节点的索引。
insertAfter(Node newChild, Node refChild)在指定的引用节点之后立即插入指定的节点。
insertBefore(Node newChild, Node refChild)将指定节点插入到紧靠指定引用节点之前。
isComposite()返回 true,因为此节点可以有子节点。
iterator()为该节点的子节点上的每个样式迭代提供支持。
joinRunsWithSameFormatting()在文档的所有段落中加入以相同格式运行。
nextPreOrder(Node rootNode)根据前序树遍历算法获取下一个节点。
nodeTypeToString(int nodeType)
normalizeFieldTypes()更改字段类型值FieldChar.getFieldType()FieldStart, FieldSeparator, FieldEnd在整个文档中,以便它们对应于域代码中包含的域类型。
notify()
notifyAll()
prependChild(Node newChild)将指定节点添加到此节点的子节点列表的开头。
previousPreOrder(Node rootNode)根据前序树遍历算法获取上一个节点。
print()打印文档而不显示任何用户界面表单。
print(String printerName)使用标准(无用户界面)打印控制器将整个文档打印到指定的打印机。
print(AttributeSet printerSettings)使用标准(无用户界面)打印控制器,根据指定的打印机设置打印文档。
print(AttributeSet printerSettings, String documentName)根据指定的打印机设置,使用标准(无用户界面)打印控制器和文档名称打印文档。
protect(int type)
protect(int type, String password)
remove()
removeAllChildren()移除当前节点的所有子节点。
removeChild(Node oldChild)删除指定的子节点。
removeExternalSchemaReferences()从此文档中删除外部 XML 模式引用。
removeMacros()从文档中删除所有宏(VBA 项目)以及工具栏和命令自定义。
removeSmartTags()删除所有SmartTag当前节点的后代节点。
renderToScale(int pageIndex, Graphics2D graphics, float x, float y, float scale)将文档页面渲染为指定比例的对象。
renderToSize(int pageIndex, Graphics2D graphics, float x, float y, float width, float height)将文档页面呈现为指定大小的对象。
save(OutputStream stream, SaveOptions saveOptions)
save(OutputStream stream, int saveFormat)
save(String fileName)保存文档。
save(String fileName, SaveOptions saveOptions)使用指定的保存选项将文档保存到文件中。
save(String fileName, int saveFormat)
selectNodes(String xpath)选择与 XPath 表达式匹配的节点列表。
selectSingleNode(String xpath)选择与 XPath 表达式匹配的第一个节点。
setAttachedTemplate(String value)设置附加到文档的模板的完整路径。
setAutomaticallyUpdateStyles(boolean value)设置一个标志,指示每次在 MS Word 中打开文档时是否更新文档中的样式以匹配附加模板中的样式。
setBackgroundShape(Shape value)设置文档的背景形状。
setCustomNodeId(int value)指定自定义节点标识符。
setCustomXmlParts(CustomXmlPartCollection value)设置自定义 XML 数据存储部件的集合。
setDefaultTabStop(double value)设置默认制表位之间的间隔(以磅为单位)。
setFontSettings(FontSettings value)设置文档字体设置。
setGlossaryDocument(GlossaryDocument value)在此文档或模板中设置词汇表文档。
setGrammarChecked(boolean value)退货true如果文档已经过语法检查。
setMailMergeSettings(MailMergeSettings value)设置包含文档的所有邮件合并信息的对象。
setNodeChangingCallback(INodeChangingCallback value)在文档中插入或删除节点时调用。
setPackageCustomParts(CustomPartCollection value)设置使用“未知关系”链接到 OOXML 包的自定义部件(任意内容)的集合。
setPageColor(Color value)设置文档的页面颜色。
setRemovePersonalInformation(boolean value)设置一个标志,指示 Microsoft Word 将在保存文档时从注释、修订和文档属性中删除所有用户信息。
setResourceLoadingCallback(IResourceLoadingCallback value)允许控制外部资源的加载方式。
setRevisionsView(int value)设置一个值,指示是使用文档的原始版本还是修订版本。
setSectionAttr(int key, Object value)
setShadeFormData(boolean value)指定是否打开表单域的灰色底纹。
setShowGrammaticalErrors(boolean value)指定是否在此文档中显示语法错误。
setShowSpellingErrors(boolean value)指定是否在此文档中显示拼写错误。
setSpellingChecked(boolean value)退货true如果文档已经过拼写检查。
setTrackRevisions(boolean value)True在 Microsoft Word 中编辑此文档时是否跟踪更改。
setVbaProject(VbaProject value)设置一个getVbaProject() / setVbaProject(com.aspose.words.VbaProject).
setWarningCallback(IWarningCallback value)当检测到可能导致数据或格式保真度丢失的问题时,在各种文档处理过程中调用。
startTrackRevisions(String author)开始自动将您以编程方式对文档所做的所有进一步更改标记为修订更改。
startTrackRevisions(String author, Date dateTime)开始自动将您以编程方式对文档所做的所有进一步更改标记为修订更改。
stopTrackRevisions()停止自动将文档更改标记为修订。
toString()
toString(SaveOptions saveOptions)使用指定的保存选项将节点的内容导出为字符串。
toString(int saveFormat)
unlinkFields()取消链接整个文档中的字段。
unprotect()从文档中删除保护。
unprotect(String password)如果指定了正确的密码,则从文档中删除保护。
updateFields()更新整个文档中的字段值。
updateListLabels()更新文档中所有列表项的列表标签。
updatePageLayout()重建文档的页面布局。
updateTableLayout()实现了一种较早的方法来重新计算具有已知问题的表格列宽。
updateThumbnail()更新BuiltInDocumentProperties.getThumbnail() / BuiltInDocumentProperties.setThumbnail(byte[])使用默认选项的文档。
updateThumbnail(ThumbnailGeneratingOptions options)更新BuiltInDocumentProperties.getThumbnail() / BuiltInDocumentProperties.setThumbnail(byte[])根据指定的选项打开文档。
updateWordCount()更新文档的字数统计属性。
updateWordCount(boolean updateLinesCount)更新文档的字数统计属性,可选择更新BuiltInDocumentProperties.getLines() / BuiltInDocumentProperties.setLines(int)财产。
wait()
wait(long arg0)
wait(long arg0, int arg1)

Document()

public Document()

创建或加载文档。创建一个空白 Word 文档。

文档纸张尺寸默认为 Letter。如果要更改页面设置,请使用Section.getPageSetup().

创建后,您可以使用DocumentBuilder轻松添加文档内容。

Document(String fileName)

public Document(String fileName)

从文件中打开现有文档。自动检测文件格式。

参数:

范围类型描述
fileNamejava.lang.String要打开的文档的文件名。

Document(String fileName, LoadOptions loadOptions)

public Document(String fileName, LoadOptions loadOptions)

从文件中打开现有文档。允许指定其他选项,例如加密密码。

参数:

范围类型描述
fileNamejava.lang.String要打开的文档的文件名。
loadOptionsLoadOptions加载文档时使用的其他选项。可以为空。

Document(InputStream stream)

public Document(InputStream stream)

初始化此类的新实例。

参数:

范围类型描述
streamjava.io.InputStream

Document(InputStream stream, LoadOptions loadOptions)

public Document(InputStream stream, LoadOptions loadOptions)

初始化此类的新实例。

参数:

范围类型描述
streamjava.io.InputStream
loadOptionsLoadOptions

accept(DocumentVisitor visitor)

public boolean accept(DocumentVisitor visitor)

接待来访者。

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

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

参数:

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

退货: boolean - 如果所有节点都被访问,则为真;如果 DocumentVisitor 在访问所有节点之前停止操作,则返回 false。调用 DocumentVisitor.VisitDocumentStart,然后为文档的所有子节点调用 Accept,最后调用 DocumentVisitor.VisitDocumentEnd。

acceptAllRevisions()

public void acceptAllRevisions()

接受文档中的所有修订。这个方法是一个捷径RevisionCollection.acceptAll().

add(Shape watermark)

public void add(Shape watermark)

参数:

范围类型描述
watermarkShape

appendChild(Node newChild)

public Node appendChild(Node newChild)

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

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

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

参数:

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

退货: Node - 添加的节点。

appendDocument(Document srcDoc, int importFormatMode)

public void appendDocument(Document srcDoc, int importFormatMode)

参数:

范围类型描述
srcDocDocument
importFormatModeint

appendDocument(Document srcDoc, int importFormatMode, ImportFormatOptions importFormatOptions)

public void appendDocument(Document srcDoc, int importFormatMode, ImportFormatOptions importFormatOptions)

参数:

范围类型描述
srcDocDocument
importFormatModeint
importFormatOptionsImportFormatOptions

cleanup()

public void cleanup()

从文档中清除未使用的样式和列表。

cleanup(CleanupOptions options)

public void cleanup(CleanupOptions options)

根据给定的内容从文档中清除未使用的样式和列表CleanupOptions.

参数:

范围类型描述
optionsCleanupOptions

clearSectionAttrs()

public void clearSectionAttrs()

compare(Document document, String author, Date dateTime)

public void compare(Document document, String author, Date dateTime)

将此文档与另一个文档进行比较,以编辑和格式修订的数量产生变化Revision.

参数:

范围类型描述
documentDocument要比较的文档。
authorjava.lang.String用于修订的作者姓名缩写。
dateTimejava.util.Date用于修订的日期和时间。目前不比较以下文档节点:

文件在比对前不得有修改。|

compare(Document document, String author, Date dateTime, CompareOptions options)

public void compare(Document document, String author, Date dateTime, CompareOptions options)

将此文档与另一个文档进行比较,产生一些编辑和格式修订的变化Revision .允许使用指定比较选项CompareOptions.

参数:

范围类型描述
documentDocument
authorjava.lang.String
dateTimejava.util.Date
optionsCompareOptions

copyStylesFromTemplate(Document template)

public void copyStylesFromTemplate(Document template)

将指定模板中的样式复制到文档中。将样式从模板复制到文档时,将重新定义文档中名称相似的样式以匹配模板中的样式描述。模板中的独特样式将复制到文档中。文档中的独特样式保持不变。

参数:

范围类型描述
templateDocument

copyStylesFromTemplate(String template)

public void copyStylesFromTemplate(String template)

将指定模板中的样式复制到文档中。将样式从模板复制到文档时,将重新定义文档中名称相似的样式以匹配模板中的样式描述。模板中的独特样式将复制到文档中。文档中的独特样式保持不变。

参数:

范围类型描述
templatejava.lang.String

dd()

public void dd()

deepClone()

public Document deepClone()

执行深拷贝Document.

退货: Document - 克隆的文档。

deepClone(boolean isCloneChildren)

public Node deepClone(boolean isCloneChildren)

创建节点的副本。

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

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

参数:

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

退货: Node - 克隆节点。

ensureMinimum()

public void ensureMinimum()

如果文档不包含任何部分,则创建一个包含一个段落的部分。

equals(Object arg0)

public boolean equals(Object arg0)

参数:

范围类型描述
arg0java.lang.Object

退货: 布尔值

expandTableStylesToDirectFormatting()

public void expandTableStylesToDirectFormatting()

将表格样式中指定的格式转换为文档中表格的直接格式。

这个方法存在是因为这个版本的 Aspose.Words 只提供对表格样式的有限支持(见下文)。当您加载包含使用表格样式格式化的表格的 DOCX 或 WordprocessingML 文档并且您需要查询表格、单元格、段落或文本的格式时,此方法可能很有用。

此版本的 Aspose.Words 对表格样式提供有限支持,如下所示:

  • 在将文档另存为 DOCX 或 WordprocessingML 时,在 DOCX 或 WordprocessingML 文档中定义的表格样式将保留为表格样式。
  • 在将文档保存为任何其他格式、渲染或打印时,DOCX 或 WordprocessingML 文档中定义的表格样式会自动转换为表格的直接格式。
  • 当仅将文档另存为 DOC 时,DOC 文档中定义的表格样式将保留为表格样式。

extractPages(int index, int count)

public Document extractPages(int index, int count)

返回Document表示指定页面范围的对象。生成的文档应该看起来像 MS Word 中的文档,就像我们执行了“打印特定页面”一样\u2013 编号、页眉/页脚和交叉表布局将被保留。但是由于大量的细微差别,在减少页数的同时出现,完全匹配版面是一项安静复杂的工作,需要付出很多努力。根据文档的复杂性,与源文档相比,生成的文档内容布局可能会略有不同。任何反馈将不胜感激。

参数:

范围类型描述
indexint要提取的第一页的从零开始的索引。
countint要提取的页数。

退货: Document

fetchInheritedSectionAttr(int key)

public Object fetchInheritedSectionAttr(int key)

参数:

范围类型描述
keyint

退货: java.lang.Object

fetchSectionAttr(int key)

public Object fetchSectionAttr(int key)

参数:

范围类型描述
keyint

退货: java.lang.Object

get()

public Shape get()

退货: Shape

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,则祖先类型匹配。

getAttachedTemplate()

public String getAttachedTemplate()

获取附加到文档的模板的完整路径。

空字符串表示文档附加到 Normal 模板。

退货: java.lang.String - 附加到文档的模板的完整路径。

getAutomaticallyUpdateStyles()

public boolean getAutomaticallyUpdateStyles()

获取一个标志,指示每次在 MS Word 中打开文档时是否更新文档中的样式以匹配附加模板中的样式。

退货: 布尔值 - 指示每次在 MS Word 中打开文档时文档中的样式是否更新以匹配附加模板中的样式的标志。

getBackgroundShape()

public Shape getBackgroundShape()

获取文档的背景形状。可以为空。

Microsoft Word 只允许具有其ShapeBase.getShapeType()财产等于ShapeType.RECTANGLE用作文档的背景形状。

Microsoft Word 仅支持背景形状的填充属性。所有其他属性都将被忽略。

将此属性设置为非空值还将设置ViewOptions.getDisplayBackgroundShape() / ViewOptions.setDisplayBackgroundShape(boolean)为真。

退货: Shape - 文档的背景形状。

getBuiltInDocumentProperties()

public BuiltInDocumentProperties getBuiltInDocumentProperties()

返回一个集合,该集合表示文档的所有内置文档属性。

退货: BuiltInDocumentProperties - 表示文档的所有内置文档属性的集合。

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

getCompatibilityOptions()

public CompatibilityOptions getCompatibilityOptions()

提供对文档兼容性选项的访问(即,在Compatibility的选项卡OptionsWord 中的对话框)。

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

getCompliance()

public int getCompliance()

获取根据加载的文档内容确定的 OOXML 合规性版本。仅对 OOXML 文档有意义。

如果您创建了一个新的空白文档或加载了非 OOXML 文档,则返回OoxmlCompliance.ECMA_376_2006价值。

退货: int - 根据加载的文档内容确定的 OOXML 合规性版本。返回值是其中之一OoxmlCompliance常数。

getContainer()

public CompositeNode getContainer()

退货: CompositeNode

getCount()

public int getCount()

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

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

getCurrentNode()

public Node getCurrentNode()

退货: Node

getCustomDocumentProperties()

public CustomDocumentProperties getCustomDocumentProperties()

返回一个集合,该集合表示文档的所有自定义文档属性。

退货: CustomDocumentProperties 代表文档的所有自定义文档属性的集合。

getCustomNodeId()

public int getCustomNodeId()

指定自定义节点标识符。

默认为零。

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

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

退货: int - 相应的 int 值。

getCustomXmlParts()

public CustomXmlPartCollection getCustomXmlParts()

获取自定义 XML 数据存储部件的集合。

Aspose.Words 仅将自定义 XML 部件加载和保存到 OOXML 和 DOC 文档中。

此属性不能为 null 。

退货: CustomXmlPartCollection 自定义 XML 数据存储部件的集合。

getDefaultTabStop()

public double getDefaultTabStop()

获取默认制表位之间的间隔(以磅为单位)。

退货: double - 默认制表位之间的间隔(以磅为单位)。

getDigitalSignatures()

public DigitalSignatureCollection getDigitalSignatures()

获取此文档的数字签名集合及其验证结果。

此集合包含从原始文档加载的数字签名。保存时不会保存这些数字签名Document将对象转换为文件或流,因为保存或转换将生成与原始文档不同的文档,并且原始数字签名将不再有效。

此集合永远不会为空。如果文档未签名,它将包含零个元素。

退货: DigitalSignatureCollection - 收集本文档的数字签名及其验证结果。

getDirectSectionAttr(int key)

public Object getDirectSectionAttr(int key)

参数:

范围类型描述
keyint

退货: java.lang.Object

getDocument()

public DocumentBase getDocument()

获取此节点所属的文档。

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

退货: DocumentBase

getEndnoteOptions()

public EndnoteOptions getEndnoteOptions()

提供控制本文档中尾注编号和位置的选项。

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

getFieldOptions()

public FieldOptions getFieldOptions()

得到一个FieldOptions表示控制文档中字段处理的选项的对象。

退货: FieldOptions - 一个FieldOptions表示控制文档中字段处理的选项的对象。

getFirstChild()

public Node getFirstChild()

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

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

getFirstSection()

public Section getFirstSection()

获取文档中的第一部分。如果没有部分,则返回 null。

退货: Section - 文档的第一部分。

getFontInfos()

public FontInfoCollection getFontInfos()

提供对本文档中使用的字体属性的访问。

该字体定义集合按原样从文档中加载。在某些文档中,字体定义可能是可选的、缺失的或不完整的。

不要依赖此集合来确定文档中使用了特定字体。您应该只使用此集合来获取有关文档中可能使用的字体的信息。

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

getFontSettings()

public FontSettings getFontSettings()

获取文档字体设置。

此属性允许为每个文档指定字体设置。如果设置为空,默认静态字体设置FontSettings.getDefaultInstance()将会被使用。

默认值为空。

退货: FontSettings 文档字体设置。

getFootnoteOptions()

public FootnoteOptions getFootnoteOptions()

提供控制本文档中脚注编号和位置的选项。

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

getFrameset()

public Frameset getFrameset()

返回一个getFrameset()例如,如果此文档代表一个框架页面。如果文档未加框,则该属性具有null价值。

退货: Frameset - 一个getFrameset()例如,如果此文档代表一个框架页面。

getGlossaryDocument()

public GlossaryDocument getGlossaryDocument()

获取此文档或模板中的词汇表文档。词汇表文档是文档中定义的自动图文集、自动更正和构建块条目的存储。

如果文档没有词汇表文档,则此属性返回 null。

您可以通过创建GlossaryDocument对象并分配给该属性。

退货: GlossaryDocument - 本文档或模板中的词汇表文档。

getGrammarChecked()

public boolean getGrammarChecked()

退货true如果文档已经过语法检查。要重新检查文档中的语法,请将此属性设置为false.

退货: 布尔值 -true如果文档已经过语法检查。

getHyphenationOptions()

public HyphenationOptions getHyphenationOptions()

提供对文档断字选项的访问。

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

getLastChild()

public Node getLastChild()

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

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

getLastSection()

public Section getLastSection()

获取文档中的最后一节。如果没有部分,则返回 null。

退货: Section - 文档的最后一部分。

getLayoutOptions()

public LayoutOptions getLayoutOptions()

得到一个LayoutOptions表示控制此文档布局过程的选项的对象。

退货: LayoutOptions - 一个LayoutOptions表示控制此文档布局过程的选项的对象。

getLists()

public ListCollection getLists()

提供对文档中使用的列表格式的访问。

有关更多信息,请参阅ListCollection班级。

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

getMailMerge()

public MailMerge getMailMerge()

返回一个MailMerge表示文档的邮件合并功能的对象。

退货: MailMerge - 一个MailMerge表示文档的邮件合并功能的对象。

getMailMergeSettings()

public MailMergeSettings getMailMergeSettings()

获取包含文档的所有邮件合并信息的对象。

您可以使用此对象为文档指定邮件合并数据源,当用户打开此文档时,此信息(连同可用的数据字段)将出现在 Microsoft Word 中。或者,您可以使用此对象查询用户在 Microsoft Word 中为此文档指定的邮件合并设置。

该对象永远不会为空。

退货: MailMergeSettings - 包含文档的所有邮件合并信息的对象。

getNextMatchingNode(Node curNode)

public Node getNextMatchingNode(Node curNode)

参数:

范围类型描述
curNodeNode

退货: Node

getNextSibling()

public Node getNextSibling()

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

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

getNodeChangingCallback()

public INodeChangingCallback getNodeChangingCallback()

在文档中插入或删除节点时调用。

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

getNodeType()

public int getNodeType()

退货NodeType.Document.

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

getOriginalFileName()

public String getOriginalFileName()

获取文档的原始文件名。

如果文档是从流中加载或创建为空白,则返回 null。

退货: java.lang.String - 文档的原始文件名。

getOriginalLoadFormat()

public int getOriginalLoadFormat()

获取加载到此对象中的原始文档的格式。

如果您创建了一个新的空白文档,则返回LoadFormat.DOC价值。

退货: int - 加载到此对象中的原始文档的格式。返回值是其中之一LoadFormat常数。

getPackageCustomParts()

public CustomPartCollection getPackageCustomParts()

获取使用“未知关系”链接到 OOXML 包的自定义部件(任意内容)的集合。

不要将这些自定义部件与自定义 XML 数据混淆。如果您需要访问自定义 XML 部分,请使用getCustomXmlParts() / setCustomXmlParts(com.aspose.words.CustomXmlPartCollection)财产。

此集合包含 OOXML 部分,其父级是 OOXML 包,它们的目标是“未知关系”。有关详细信息,请参阅CustomPart.

Aspose.Words 仅将自定义部分加载和保存到 OOXML 文档中。

此属性不能为 null 。

退货: CustomPartCollection - 使用“未知关系”链接到 OOXML 包的自定义部分(任意内容)的集合。

getPageColor()

public Color getPageColor()

获取文档的页面颜色。此属性是getBackgroundShape() / setBackgroundShape(com.aspose.words.Shape).

此属性提供了一种为文档指定纯色页面颜色的简单方法。设置此属性会创建并设置一个适当的getBackgroundShape() / setBackgroundShape(com.aspose.words.Shape).

如果未设置页面颜色(例如,文档中没有背景形状),则返回零颜色。

退货: java.awt.Color - 文档的页面颜色。

getPageCount()

public int getPageCount()

获取根据最近的页面布局操作计算的文档中的页数。

退货: int - 根据最近的页面布局操作计算的文档中的页数。

getPageInfo(int pageIndex)

public PageInfo getPageInfo(int pageIndex)

获取可能对打印或呈现有用的页面大小、方向和其他有关页面的信息。

参数:

范围类型描述
pageIndexint基于 0 的页面索引。

退货: PageInfo

getParentNode()

public CompositeNode getParentNode()

获取此节点的直接父级。

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

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

getPreviousSibling()

public Node getPreviousSibling()

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

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

getProtectionType()

public int getProtectionType()

获取当前活动的文档保护类型。

此属性允许检索当前设置的文档保护类型。要更改文档保护类型,请使用**M:Aspose.Words.Document.Protect(Aspose.Words.ProtectionType,System.String)**和unprotect()方法。

当文档受到保护时,用户只能进行有限的更改,例如添加注释、进行修订或填写表格。

请注意,文档保护不同于写保护。写保护是使用指定getWriteProtection()

M:Aspose.Words.Document.Protect(Aspose.Words.ProtectionType,System.String)

退货: int - 当前活动的文档保护类型。返回值是其中之一ProtectionType常数。

getRange()

public Range getRange()

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

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

getRemovePersonalInformation()

public boolean getRemovePersonalInformation()

获取一个标志,指示 Microsoft Word 将在保存文档时从注释、修订和文档属性中删除所有用户信息。

退货: boolean - 一个标志,表示 Microsoft Word 将在保存文档时从注释、修订和文档属性中删除所有用户信息。

getResourceLoadingCallback()

public IResourceLoadingCallback getResourceLoadingCallback()

允许控制外部资源的加载方式。

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

getRevisions()

public RevisionCollection getRevisions()

获取此文档中存在的修订(跟踪更改)的集合。

返回的集合是一个“实时”集合,这意味着如果您删除包含修订的文档部分,删除的修订将自动从该集合中消失。

退货: RevisionCollection - 本文档中存在的修订(跟踪更改)的集合。

getRevisionsView()

public int getRevisionsView()

获取一个值,该值指示是使用文档的原始版本还是修订版本。默认值为**RevisionsView.ORIGINAL** .

退货: int - 一个值,指示是使用文档的原始版本还是修订版本。返回值是其中之一RevisionsView常数。

getSections()

public SectionCollection getSections()

返回代表文档中所有部分的集合。

退货: SectionCollection 代表文档中所有部分的集合。

getShadeFormData()

public boolean getShadeFormData()

指定是否打开表单域的灰色底纹。

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

getShowGrammaticalErrors()

public boolean getShowGrammaticalErrors()

指定是否在此文档中显示语法错误。

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

getShowSpellingErrors()

public boolean getShowSpellingErrors()

指定是否在此文档中显示拼写错误。

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

getSpellingChecked()

public boolean getSpellingChecked()

退货true如果文档已经过拼写检查。要重新检查文档中的拼写,请将此属性设置为false.

退货: 布尔值 -true如果文档已经过拼写检查。

getStyles()

public StyleCollection getStyles()

返回文档中定义的样式集合。

有关更多信息,请参阅StyleCollection班级。

退货: StyleCollection 文档中定义的样式集合。

getText()

public String getText()

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

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

退货: java.lang.字符串

getTheme()

public Theme getTheme()

获取getTheme()本文档的对象。

退货: Theme - 这getTheme()本文档的对象。

getTrackRevisions()

public boolean getTrackRevisions()

True在 Microsoft Word 中编辑此文档时是否跟踪更改。

设置此选项仅指示 Microsoft Word 是否打开或关闭修订。此属性对您通过 Aspose.Words 以编程方式对文档所做的更改没有影响。

如果您想自动跟踪 Aspose.Words 以编程方式对本文档所做的更改,请使用startTrackRevisions(java.lang.String, java.util.Date)方法。

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

getVariables()

public VariableCollection getVariables()

返回添加到文档或模板的变量集合。

退货: VariableCollection 添加到文档或模板的变量集合。

getVbaProject()

public VbaProject getVbaProject()

得到一个getVbaProject() / setVbaProject(com.aspose.words.VbaProject).

退货: VbaProject - 一个getVbaProject() / setVbaProject(com.aspose.words.VbaProject).

getVersionsCount()

public int getVersionsCount()

获取存储在 DOC 文档中的文档版本数。

Microsoft Word 中的版本可通过文件/版本菜单访问。 Microsoft Word 仅支持 DOC 文件的版本。

此属性允许检测在 Aspose.Words 中打开此文档之前是否有文档版本存储在此文档中。 Aspose.Words 不为文档版本提供其他支持。如果您使用 Aspose.Words 保存该文档,则该文档将被保存而没有版本。

退货: int - 存储在 DOC 文档中的文档版本数。

getViewOptions()

public ViewOptions getViewOptions()

提供选项以控制文档在 Microsoft Word 中的显示方式。

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

getWarningCallback()

public IWarningCallback getWarningCallback()

当检测到可能导致数据或格式保真度丢失的问题时,在各种文档处理过程中调用。文档可能在其存在的任何阶段产生警告,因此尽早设置警告回调以避免警告丢失非常重要。例如这样的属性Document.getPageCount()实际构建稍后用于渲染的文档布局,如果为稍后的渲染调用指定警告回调,布局警告可能会丢失。

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

getWatermark()

public Watermark getWatermark()

提供对文档水印的访问。

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

getWebExtensionTaskPanes()

public TaskPaneCollection getWebExtensionTaskPanes()

返回表示任务窗格加载项列表的集合。

退货: TaskPaneCollection 表示任务窗格加载项列表的集合。

getWriteProtection()

public WriteProtection getWriteProtection()

提供对文档写保护选项的访问。

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

hasChildNodes()

public boolean hasChildNodes()

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

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

hasMacros()

public boolean hasMacros()

退货true如果文档有 VBA 项目(宏)。

退货: 布尔值 -true如果文档有 VBA 项目(宏)。

hasRevisions()

public boolean hasRevisions()

退货true如果文档有任何跟踪更改。此属性是比较的快捷方式RevisionCollection.getCount()归零。

退货: 布尔值 -true如果文档有任何跟踪更改。

hashCode()

public native int hashCode()

退货: 整数

importNode(Node srcNode, boolean isImportChildren)

public Node importNode(Node srcNode, boolean isImportChildren)

将节点从另一个文档导入到当前文档。

将节点从另一个文档导入到当前文档。

此方法使用ImportFormatMode.USE_DESTINATION_STYLES解决格式化的选项。

导入节点会创建属于导入文档的源节点的副本。返回的节点没有父节点。源节点未更改或从原始文档中删除。

在将来自另一个文档的节点插入到该文档之前,必须导入它。在导入过程中,特定于文档的属性(例如对样式和列表的引用)将从原始文档转换为导入文档。节点导入后,可以使用插入到文档中的适当位置CompositeNode.insertBefore(com.aspose.words.Node, com.aspose.words.Node)或者CompositeNode.insertAfter(com.aspose.words.Node, com.aspose.words.Node).

如果源节点已经属于目标文档,则只需创建源节点的深度克隆。

参数:

范围类型描述
srcNodeNode正在导入的节点。
isImportChildrenbooleanTrue 递归导入所有子节点;否则,假的。

退货: Node 属于当前文档的克隆节点。

importNode(Node srcNode, boolean isImportChildren, int importFormatMode)

public Node importNode(Node srcNode, boolean isImportChildren, int importFormatMode)

参数:

范围类型描述
srcNodeNode
isImportChildrenboolean
importFormatModeint

退货: Node

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 因为这个节点可以有子节点。

iterator()

public Iterator iterator()

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

退货: java.util.迭代器

joinRunsWithSameFormatting()

public int joinRunsWithSameFormatting()

在文档的所有段落中加入以相同格式运行。

这是一种优化方法。一些文档包含具有相同格式的相邻运行。如果文档是手动密集编辑的,通常会发生这种情况。您可以通过加入这些运行来减小文档大小并加快进一步处理。

操作检查每个Paragraph相邻文档中的节点Run具有相同属性的节点。它忽略了用于跟踪运行创建和修改的编辑会话的唯一标识符。每个连接序列中的第一次运行会累积所有文本。剩余的运行将从文档中删除。

退货: int - 执行的连接数。什么时候N相邻的运行正在被加入,它们算作N - 1加入。

nextPreOrder(Node rootNode)

public Node nextPreOrder(Node rootNode)

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

参数:

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

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

nodeTypeToString(int nodeType)

public static String nodeTypeToString(int nodeType)

参数:

范围类型描述
nodeTypeint

退货: java.lang.字符串

normalizeFieldTypes()

public void normalizeFieldTypes()

更改字段类型值FieldChar.getFieldType()FieldStart, FieldSeparator, FieldEnd在整个文档中,以便它们对应于域代码中包含的域类型。

在影响字段类型的文档更改后使用此方法。

要更改文档特定部分中的字段类型值,请使用Range.normalizeFieldTypes().

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 预购顺序中的前一个节点。如果到达根节点则为空。

public void print()

打印文档而不显示任何用户界面表单。将整个文档打印到默认打印机。

public void print(String printerName)

使用标准(无用户界面)打印控制器将整个文档打印到指定的打印机。

参数:

范围类型描述
printerNamejava.lang.String打印机的名称。
public void print(AttributeSet printerSettings)

使用标准(无用户界面)打印控制器,根据指定的打印机设置打印文档。

该对象允许您指定要打印的打印机、要打印的页面范围和其他选项。

可以同时包含配置 PrintJob 请求和配置 PrintService 查找。

参数:

范围类型描述
printerSettingsjavax.print.attribute.AttributeSet要使用的打印机设置。
public void print(AttributeSet printerSettings, String documentName)

根据指定的打印机设置,使用标准(无用户界面)打印控制器和文档名称打印文档。

该对象允许您指定要打印的打印机、要打印的页面范围和其他选项。

可以同时包含配置 PrintJob 请求和配置 PrintService 查找。

参数:

范围类型描述
printerSettingsjavax.print.attribute.AttributeSet要使用的打印机设置。
documentNamejava.lang.String打印文档时要显示的文档名称(例如,在打印状态对话框或打印机队列中)。

protect(int type)

public void protect(int type)

参数:

范围类型描述
typeint

protect(int type, String password)

public void protect(int type, String password)

参数:

范围类型描述
typeint
passwordjava.lang.String

remove()

public void remove()

从父级中移除自身。

removeAllChildren()

public void removeAllChildren()

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

removeChild(Node oldChild)

public Node removeChild(Node oldChild)

删除指定的子节点。

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

参数:

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

退货: Node - 删除的节点。

removeExternalSchemaReferences()

public void removeExternalSchemaReferences()

从此文档中删除外部 XML 模式引用。

removeMacros()

public void removeMacros()

从文档中删除所有宏(VBA 项目)以及工具栏和命令自定义。

通过从文档中删除所有宏,您可以确保该文档不包含宏病毒。

removeSmartTags()

public void removeSmartTags()

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

renderToScale(int pageIndex, Graphics2D graphics, float x, float y, float scale)

public Point2D.Float renderToScale(int pageIndex, Graphics2D graphics, float x, float y, float scale)

将文档页面渲染为指定比例的对象。

参数:

范围类型描述
pageIndexint基于 0 的页面索引。
graphicsjava.awt.Graphics2D要渲染到的对象。
xfloat呈现页面左上角的 X 坐标(以世界单位表示)。
yfloat呈现页面左上角的 Y 坐标(以世界单位表示)。
scalefloat呈现页面的比例(1.0 为 100%)。

退货: java.awt.geom.Point2D.Float - 渲染页面的宽度和高度(世界单位)。

renderToSize(int pageIndex, Graphics2D graphics, float x, float y, float width, float height)

public float renderToSize(int pageIndex, Graphics2D graphics, float x, float y, float width, float height)

将文档页面呈现为指定大小的对象。

参数:

范围类型描述
pageIndexint基于 0 的页面索引。
graphicsjava.awt.Graphics2D要渲染到的对象。
xfloat呈现页面左上角的 X 坐标(以世界单位表示)。
yfloat呈现页面左上角的 Y 坐标(以世界单位表示)。
widthfloat渲染页面可以占据的最大宽度(以世界单位为单位)。
heightfloat渲染页面可以占据的最大高度(以世界单位为单位)。

退货: float - 为呈现的页面自动计算以适合指定大小的比例。

save(OutputStream stream, SaveOptions saveOptions)

public SaveOutputParameters save(OutputStream stream, SaveOptions saveOptions)

参数:

范围类型描述
streamjava.io.OutputStream
saveOptionsSaveOptions

退货: SaveOutputParameters

save(OutputStream stream, int saveFormat)

public SaveOutputParameters save(OutputStream stream, int saveFormat)

参数:

范围类型描述
streamjava.io.OutputStream
saveFormatint

退货: SaveOutputParameters

save(String fileName)

public SaveOutputParameters save(String fileName)

保存文档。将文档保存到文件中。自动确定扩展名的保存格式。

参数:

范围类型描述
fileNamejava.lang.String文档的名称。如果具有指定文件名的文档已经存在,则覆盖现有文档。

退货: SaveOutputParameters - 您可以选择使用的附加信息。

save(String fileName, SaveOptions saveOptions)

public SaveOutputParameters save(String fileName, SaveOptions saveOptions)

使用指定的保存选项将文档保存到文件中。

参数:

范围类型描述
fileNamejava.lang.String文档的名称。如果具有指定文件名的文档已经存在,则覆盖现有文档。
saveOptionsSaveOptions指定控制文档保存方式的选项。可以为空。

退货: SaveOutputParameters - 您可以选择使用的附加信息。

save(String fileName, int saveFormat)

public SaveOutputParameters save(String fileName, int saveFormat)

参数:

范围类型描述
fileNamejava.lang.String
saveFormatint

退货: SaveOutputParameters

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。

setAttachedTemplate(String value)

public void setAttachedTemplate(String value)

设置附加到文档的模板的完整路径。

空字符串表示文档附加到 Normal 模板。

参数:

范围类型描述
valuejava.lang.String附加到文档的模板的完整路径。

setAutomaticallyUpdateStyles(boolean value)

public void setAutomaticallyUpdateStyles(boolean value)

设置一个标志,指示每次在 MS Word 中打开文档时是否更新文档中的样式以匹配附加模板中的样式。

参数:

范围类型描述
valueboolean一个标志,指示每次在 MS Word 中打开文档时,文档中的样式是否更新以匹配附加模板中的样式。

setBackgroundShape(Shape value)

public void setBackgroundShape(Shape value)

设置文档的背景形状。可以为空。

Microsoft Word 只允许具有其ShapeBase.getShapeType()财产等于ShapeType.RECTANGLE用作文档的背景形状。

Microsoft Word 仅支持背景形状的填充属性。所有其他属性都将被忽略。

将此属性设置为非空值还将设置ViewOptions.getDisplayBackgroundShape() / ViewOptions.setDisplayBackgroundShape(boolean)为真。

参数:

范围类型描述
valueShape文档的背景形状。

setCustomNodeId(int value)

public void setCustomNodeId(int value)

指定自定义节点标识符。

默认为零。

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

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

参数:

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

setCustomXmlParts(CustomXmlPartCollection value)

public void setCustomXmlParts(CustomXmlPartCollection value)

设置自定义 XML 数据存储部件的集合。

Aspose.Words 仅将自定义 XML 部件加载和保存到 OOXML 和 DOC 文档中。

此属性不能为 null 。

参数:

范围类型描述
valueCustomXmlPartCollection自定义 XML 数据存储部件的集合。

setDefaultTabStop(double value)

public void setDefaultTabStop(double value)

设置默认制表位之间的间隔(以磅为单位)。

参数:

范围类型描述
valuedouble默认制表位之间的间隔(以磅为单位)。

setFontSettings(FontSettings value)

public void setFontSettings(FontSettings value)

设置文档字体设置。

此属性允许为每个文档指定字体设置。如果设置为空,默认静态字体设置FontSettings.getDefaultInstance()将会被使用。

默认值为空。

参数:

范围类型描述
valueFontSettings文档字体设置。

setGlossaryDocument(GlossaryDocument value)

public void setGlossaryDocument(GlossaryDocument value)

在此文档或模板中设置词汇表文档。词汇表文档是文档中定义的自动图文集、自动更正和构建块条目的存储。

如果文档没有词汇表文档,则此属性返回 null。

您可以通过创建GlossaryDocument对象并分配给该属性。

参数:

范围类型描述
valueGlossaryDocument本文档或模板中的词汇表文档。

setGrammarChecked(boolean value)

public void setGrammarChecked(boolean value)

退货true如果文档已经过语法检查。要重新检查文档中的语法,请将此属性设置为false.

参数:

范围类型描述
valuebooleantrue如果文档已经过语法检查。

setMailMergeSettings(MailMergeSettings value)

public void setMailMergeSettings(MailMergeSettings value)

设置包含文档的所有邮件合并信息的对象。

您可以使用此对象为文档指定邮件合并数据源,当用户打开此文档时,此信息(连同可用的数据字段)将出现在 Microsoft Word 中。或者,您可以使用此对象查询用户在 Microsoft Word 中为此文档指定的邮件合并设置。

该对象永远不会为空。

参数:

范围类型描述
valueMailMergeSettings包含文档的所有邮件合并信息的对象。

setNodeChangingCallback(INodeChangingCallback value)

public void setNodeChangingCallback(INodeChangingCallback value)

在文档中插入或删除节点时调用。

参数:

范围类型描述
valueINodeChangingCallback相应的INodeChangingCallback价值。

setPackageCustomParts(CustomPartCollection value)

public void setPackageCustomParts(CustomPartCollection value)

设置使用“未知关系”链接到 OOXML 包的自定义部件(任意内容)的集合。

不要将这些自定义部件与自定义 XML 数据混淆。如果您需要访问自定义 XML 部分,请使用getCustomXmlParts() / setCustomXmlParts(com.aspose.words.CustomXmlPartCollection)财产。

此集合包含 OOXML 部分,其父级是 OOXML 包,它们的目标是“未知关系”。有关详细信息,请参阅CustomPart.

Aspose.Words 仅将自定义部分加载和保存到 OOXML 文档中。

此属性不能为 null 。

参数:

范围类型描述
valueCustomPartCollection使用“未知关系”链接到 OOXML 包的自定义部分(任意内容)的集合。

setPageColor(Color value)

public void setPageColor(Color value)

设置文档的页面颜色。此属性是getBackgroundShape() / setBackgroundShape(com.aspose.words.Shape).

此属性提供了一种为文档指定纯色页面颜色的简单方法。设置此属性会创建并设置一个适当的getBackgroundShape() / setBackgroundShape(com.aspose.words.Shape).

如果未设置页面颜色(例如,文档中没有背景形状),则返回零颜色。

参数:

范围类型描述
valuejava.awt.Color文档的页面颜色。

setRemovePersonalInformation(boolean value)

public void setRemovePersonalInformation(boolean value)

设置一个标志,指示 Microsoft Word 将在保存文档时从注释、修订和文档属性中删除所有用户信息。

参数:

范围类型描述
valueboolean一个标志,表示 Microsoft Word 将在保存文档时从评论、修订和文档属性中删除所有用户信息。

setResourceLoadingCallback(IResourceLoadingCallback value)

public void setResourceLoadingCallback(IResourceLoadingCallback value)

允许控制外部资源的加载方式。

参数:

范围类型描述
valueIResourceLoadingCallback相应的IResourceLoadingCallback价值。

setRevisionsView(int value)

public void setRevisionsView(int value)

设置一个值,指示是使用文档的原始版本还是修订版本。默认值为**RevisionsView.ORIGINAL** .

参数:

范围类型描述
valueint一个值,指示是使用文档的原始版本还是修订版本。该值必须是其中之一RevisionsView常数。

setSectionAttr(int key, Object value)

public void setSectionAttr(int key, Object value)

参数:

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

setShadeFormData(boolean value)

public void setShadeFormData(boolean value)

指定是否打开表单域的灰色底纹。

参数:

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

setShowGrammaticalErrors(boolean value)

public void setShowGrammaticalErrors(boolean value)

指定是否在此文档中显示语法错误。

参数:

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

setShowSpellingErrors(boolean value)

public void setShowSpellingErrors(boolean value)

指定是否在此文档中显示拼写错误。

参数:

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

setSpellingChecked(boolean value)

public void setSpellingChecked(boolean value)

退货true如果文档已经过拼写检查。要重新检查文档中的拼写,请将此属性设置为false.

参数:

范围类型描述
valuebooleantrue如果文档已经过拼写检查。

setTrackRevisions(boolean value)

public void setTrackRevisions(boolean value)

True在 Microsoft Word 中编辑此文档时是否跟踪更改。

设置此选项仅指示 Microsoft Word 是否打开或关闭修订。此属性对您通过 Aspose.Words 以编程方式对文档所做的更改没有影响。

如果您想自动跟踪 Aspose.Words 以编程方式对本文档所做的更改,请使用startTrackRevisions(java.lang.String, java.util.Date)方法。

参数:

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

setVbaProject(VbaProject value)

public void setVbaProject(VbaProject value)

设置一个getVbaProject() / setVbaProject(com.aspose.words.VbaProject).

参数:

范围类型描述
valueVbaProject一个getVbaProject() / setVbaProject(com.aspose.words.VbaProject).

setWarningCallback(IWarningCallback value)

public void setWarningCallback(IWarningCallback value)

当检测到可能导致数据或格式保真度丢失的问题时,在各种文档处理过程中调用。文档可能在其存在的任何阶段产生警告,因此尽早设置警告回调以避免警告丢失非常重要。例如这样的属性Document.getPageCount()实际构建稍后用于渲染的文档布局,如果为稍后的渲染调用指定警告回调,布局警告可能会丢失。

参数:

范围类型描述
valueIWarningCallback相应的IWarningCallback价值。

startTrackRevisions(String author)

public void startTrackRevisions(String author)

开始自动将您以编程方式对文档所做的所有进一步更改标记为修订更改。

如果您调用此方法,然后以编程方式对文档进行一些更改,保存文档并稍后在 MS Word 中打开文档,您将看到这些更改为修订。

目前 Aspose.Words 仅支持跟踪节点插入和删除。格式更改不会记录为修订。

通过节点操作修改此文档以及使用DocumentBuilder

这种方法不会改变getTrackRevisions() / setTrackRevisions(boolean)选项并且不将其值用于修订跟踪的目的。

参数:

范围类型描述
authorjava.lang.String用于修订的作者姓名缩写。

startTrackRevisions(String author, Date dateTime)

public void startTrackRevisions(String author, Date dateTime)

开始自动将您以编程方式对文档所做的所有进一步更改标记为修订更改。

如果您调用此方法,然后以编程方式对文档进行一些更改,保存文档并稍后在 MS Word 中打开文档,您将看到这些更改为修订。

目前 Aspose.Words 仅支持跟踪节点插入和删除。格式更改不会记录为修订。

通过节点操作修改此文档以及使用DocumentBuilder

这种方法不会改变getTrackRevisions() / setTrackRevisions(boolean)选项并且不将其值用于修订跟踪的目的。

参数:

范围类型描述
authorjava.lang.String用于修订的作者姓名缩写。
dateTimejava.util.Date用于修订的日期和时间。

stopTrackRevisions()

public void stopTrackRevisions()

停止自动将文档更改标记为修订。

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.字符串

unlinkFields()

public void unlinkFields()

取消链接整个文档中的字段。

将整个文档中的所有字段替换为其最新结果。

要取消链接文档特定部分中的字段,请使用Range.unlinkFields().

unprotect()

public void unprotect()

从文档中删除保护。无论密码如何,都会从文档中删除保护。

即使文档有保护密码,此方法也会取消对文档的保护。

请注意,文档保护不同于写保护。写保护是使用指定getWriteProtection().

unprotect(String password)

public boolean unprotect(String password)

如果指定了正确的密码,则从文档中删除保护。

仅当指定了正确的密码时,此方法才会取消对文档的保护。

请注意,文档保护不同于写保护。写保护是使用指定getWriteProtection().

参数:

范围类型描述
passwordjava.lang.String用于取消保护文档的密码。

退货: boolean - 如果指定了正确的密码并且文档未受保护则为真。

updateFields()

public void updateFields()

更新整个文档中的字段值。

当您打开、修改然后保存文档时,Aspose.Words 不会自动更新字段,而是保持它们的完整性。因此,如果您以编程方式修改了文档并希望确保正确的(计算的)字段值出现在保存的文档中,则通常需要在保存之前调用此方法。

执行邮件合并后不需要更新字段,因为邮件合并是一种字段更新,会自动更新文档中的所有字段。

此方法不会更新所有字段类型。有关支持的字段类型的详细列表,请参阅《程序员指南》。

此方法不会更新与页面布局算法相关的字段(例如 PAGE、PAGES、PAGEREF)。当您呈现文档或调用时,页面布局相关的字段会更新updatePageLayout().

使用normalizeFieldTypes()如果存在影响字段类型的文档更改,则字段更新之前的方法。

要更新文档特定部分中的字段,请使用Range.updateFields().

updateListLabels()

public void updateListLabels()

更新文档中所有列表项的列表标签。

此方法更新列表标签属性,例如ListLabel.getLabelValue()ListLabel.getLabelString()每个Paragraph.getListLabel()文档中的对象。

此外,在更新文档中的字段时,有时会隐式调用此方法。这是必需的,因为某些可能引用列表编号的字段(例如 TOC 或 REF)需要它们是最新的。

updatePageLayout()

public void updatePageLayout()

重建文档的页面布局。

此方法将文档格式化为页面并更新文档中与页码相关的字段,如 PAGE、PAGES、PAGEREF 和 REF。将文档正确呈现为固定页面格式需要最新的页面布局信息。

当您第一次将文档转换为 PDF、XPS、图像或打印时,会自动调用此方法。但是,如果您在呈现后修改文档然后尝试再次呈现它 - Aspose.Words 将不会自动更新页面布局。在这种情况下,您应该致电updatePageLayout()在再次渲染之前。

updateTableLayout()

public void updateTableLayout()

实现了一种较早的方法来重新计算具有已知问题的表格列宽。该方法已弃用,将在几个版本中删除。

updateThumbnail()

public void updateThumbnail()

更新BuiltInDocumentProperties.getThumbnail() / BuiltInDocumentProperties.setThumbnail(byte[])使用默认选项的文档。

updateThumbnail(ThumbnailGeneratingOptions options)

public void updateThumbnail(ThumbnailGeneratingOptions options)

更新BuiltInDocumentProperties.getThumbnail() / BuiltInDocumentProperties.setThumbnail(byte[])根据指定的选项打开文档。这ThumbnailGeneratingOptions允许您指定缩略图的来源、大小和其他选项。如果尝试生成缩略图失败,则不更改。

参数:

范围类型描述
optionsThumbnailGeneratingOptions要使用的生成选项。

updateWordCount()

public void updateWordCount()

更新文档的字数统计属性。

UpdateWordCount重新计算和更新字符、单词和段落属性getBuiltInDocumentProperties()的集合Document.

注意UpdateWordCount不更新行数和页数属性。使用updateWordCount()重载并将 True 值作为参数传递来执行此操作。

使用评估版时,评估水印也会计入字数。

updateWordCount(boolean updateLinesCount)

public void updateWordCount(boolean updateLinesCount)

更新文档的字数统计属性,可选择更新BuiltInDocumentProperties.getLines() / BuiltInDocumentProperties.setLines(int)财产。此方法将重建文档的页面布局。

参数:

范围类型描述
updateLinesCountboolean如果应计算文档中的行数,则为真。

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