Document

概述

Document 是 Aspose.Words FOSS 中用于 .NET 的类。继承自：DocumentBase，ISectionAttrSource，IWatermarkProvider。

Document 类的构造函数允许开发者创建一个新的空文档，或从文件路径、流或自定义加载选项中加载已有文档。

此类在 .NET 程序中提供了 63 个用于操作 Document 对象的方法。可用的方法包括：Accept、AcceptAllRevisions、AcceptEnd、AcceptStart、AppendChild、AppendDocument、Cleanup、Clone、CopyStylesFromTemplate、CreateNavigator、Document、EnsureMinimum，以及另外 36 个方法。安装 Aspose.Words FOSS for .NET 包后，所有公共成员对任何 .NET 应用程序均可访问。属性：AttachedTemplate、AutomaticallyUpdateStyles、BackgroundShape、Bibliography、BuiltInDocumentProperties、CompatibilityOptions，以及另外 62 项。

属性

名称	类型	访问	描述
`AttachedTemplate`	`string`	读写	获取或设置附加到文档的模板的完整路径.
`AutomaticallyUpdateStyles`	`bool`	读写	获取或设置一个标志，指示每次在 MS Word 中打开文档时，文档中的样式是否会更新以匹配附加模板中的样式.
`ShadeFormData`	`bool`	读写	指定是否在表单字段上启用灰色阴影。
`TrackRevisions`	`bool`	读写	如果在 Microsoft Word 中编辑此文档时启用了更改跟踪，则为 True。
`ShowGrammaticalErrors`	`bool`	读写	指定是否在此文档中显示语法错误。
`ShowSpellingErrors`	`bool`	读写	指定是否在此文档中显示拼写错误。
`SpellingChecked`	`bool`	读写	如果文档已进行拼写检查，则返回 true。
`GrammarChecked`	`bool`	读写	如果文档已进行语法检查，则返回 true。
`PunctuationKerning`	`bool`	读写	指定字距调整是否适用于拉丁文本和标点符号。
`NodeType`	`NodeType`	读取	返回 Document。
`BuiltInDocumentProperties`	`BuiltInDocumentProperties`	读取	返回一个集合，代表文档的所有内置文档属性。
`WebExtensionTaskPanes`	`TaskPaneCollection`	读取	返回一个集合，代表任务窗格加载项的列表。
`CustomDocumentProperties`	`CustomDocumentProperties`	读取	返回一个集合，代表文档的所有自定义文档属性。
`ProtectionType`	`ProtectionType`	读取	获取当前活动的文档保护类型。
`Sections`	`SectionCollection`	读取	返回一个集合，表示文档中的所有章节。
`FirstSection`	`Section`	读取	获取文档中的第一个章节。
`LastSection`	`Section`	读取	获取文档中的最后一个节。
`ViewOptions`	`ViewOptions`	读取	提供控制文档在 Microsoft Word 中显示方式的选项。
`WriteProtection`	`WriteProtection`	读取	提供访问文档写保护选项的功能。
`CompatibilityOptions`	`CompatibilityOptions`	读取	提供访问文档兼容性选项的功能（即在 Word 的“选项”对话框的“兼容性”选项卡中输入的用户首选项）。
`MailMergeSettings`	`MailMergeSettings`	读写	获取或设置包含文档所有邮件合并信息的对象。
`HyphenationOptions`	`HyphenationOptions`	读取	提供对文档连字符选项的访问。
`HasRevisions`	`bool`	读取	如果文档有任何已跟踪的更改，则返回 true。
`HasMacros`	`bool`	读取	如果文档包含 VBA 项目（宏），则返回 true。
`Watermark`	`Watermark`	读取	提供对文档水印的访问。
`VersionsCount`	`int`	读取	获取存储在 DOC 文档中的文档版本数量。
`DefaultTabStop`	`double`	读写	获取或设置默认制表位之间的间隔（以点为单位）。
`Theme`	`Theme`	读取	获取此文档的 Theme 对象。
`CustomXmlParts`	`CustomXmlPartCollection`	读写	获取或设置自定义 XML 数据存储部件的集合。
`PackageCustomParts`	`CustomPartCollection`	读写	获取或设置自定义部件（任意内容）的集合，这些部件通过“未知关系”链接到 OOXML 包。
`Variables`	`VariableCollection`	读取	返回添加到文档或模板的变量集合。
`GlossaryDocument`	`GlossaryDocument`	读写	获取或设置此文档或模板中的词汇表文档。
`OriginalFileName`	`string`	读取	获取文档的原始文件名。
`OriginalLoadFormat`	`LoadFormat`	读取	获取加载到此对象中的原始文档的格式。
`Compliance`	`OoxmlCompliance`	读取	获取从已加载的文档内容确定的 OOXML 合规版本。
`DigitalSignatures`	`DigitalSignatureCollection`	读取	获取此文档的数字签名集合及其验证结果。
`FontSettings`	`FontSettings`	读写	获取或设置文档字体设置。
`Bibliography`	`Bibliography.Bibliography`	读取	获取表示文档中可用来源列表的 Bibliography 对象。
`Frameset`	`Frameset`	读取	如果此文档表示帧页面，则返回一个 Frameset 实例。
`IncludeTextboxesFootnotesEndnotesInStat`	`bool`	读写	指定是否在字数统计中包含文本框、脚注和尾注。
`Revisions`	`RevisionCollection`	读取	获取此文档中存在的修订集合（已跟踪的更改）。
`RevisionsView`	`RevisionsView`	读写	获取或设置一个值，指示是使用文档的原始版本还是修订版本。
`JustificationMode`	`JustificationMode`	读写	获取或设置文档的字符间距调整。
`FootnoteOptions`	`FootnoteOptions`	读取	提供控制本文件中脚注编号和位置的选项。
`EndnoteOptions`	`EndnoteOptions`	读取	提供控制本文件中尾注编号和位置的选项。
`FieldOptions`	`FieldOptions`	读取	获取一个 FieldOptions 对象，该对象表示用于控制文档中字段处理的选项。
`RemovePersonalInformation`	`bool`	读写	获取或设置一个标志，指示 Microsoft Word 在保存文档时会删除评论、修订和文档属性中的所有用户信息。
`VbaProject`	`VbaProject`	读写	获取或设置一个 VbaProject。
`Document`	`DocumentBase`	读取	获取此实例。
`NodeChangingCallback`	`INodeChangingCallback`	读写	当文档中插入或删除节点时调用。
`ResourceLoadingCallback`	`IResourceLoadingCallback`	读写	允许控制外部资源的加载方式。
`FontInfos`	`FontInfoCollection`	读取	提供对本文件中使用的字体属性的访问。
`Styles`	`StyleCollection`	读取	返回文档中定义的样式集合。
`Lists`	`ListCollection`	读取	提供对文档中使用的列表格式的访问。
`WarningCallback`	`IWarningCallback`	读写	在检测到可能导致数据或格式保真度丢失的问题时，于各种文档处理过程期间调用。
`FootnoteSeparators`	`FootnoteSeparatorCollection`	读取	提供对文档中定义的脚注/尾注分隔符的访问。
`BackgroundShape`	`Shape`	读写	获取或设置文档的背景形状。
`PageColor`	`Color`	读写	获取或设置文档的页面颜色。
`IsComposite`	`bool`	读取	返回 true，因为此节点可以拥有子节点。
`HasChildNodes`	`bool`	读取	如果此节点有任何子节点，则返回 true。
`FirstChild`	`Node`	读取	获取节点的第一个子节点。
`LastChild`	`Node`	读取	获取节点的最后一个子节点。
`Count`	`int`	读取	获取此节点的直接子节点数量。
`ParentNode`	`CompositeNode`	读取	获取此节点的直接父节点。
`PreviousSibling`	`Node`	读取	获取紧邻此节点的前一个节点。
`NextSibling`	`Node`	读取	获取紧随此节点的节点。
`Range`	`Range`	读取	返回一个 Range 对象，表示该节点中包含的文档部分。
`CustomNodeId`	`int`	读写	指定自定义节点标识符。

方法

签名	描述
`Document()`	创建或加载文档。
`Document(fileName: string)`	从文件打开现有文档。
`Document(fileName: string, loadOptions: LoadOptions)`	从文件打开现有文档。
`Document(stream: Stream)`	在此 Document 实例上调用 Document(stream)。
`Document(stream: Stream, loadOptions: LoadOptions)`	在此 Document 实例上调用 Document(stream, loadOptions)。
`Clone()`	对 Document 执行深拷贝。
`Accept(visitor: DocumentVisitor)`	调用 VisitDocumentStart，然后对文档的所有子节点调用 Accept，并在最后调用 VisitDocumentEnd。
`AcceptStart(visitor: DocumentVisitor)`	接受一个访问者以访问文档的开始。
`AcceptEnd(visitor: DocumentVisitor)`	接受一个访问者以访问文档的结束。
`AppendDocument(srcDoc: Document, importFormatMode: ImportFormatMode)`	将指定的文档追加到此文档的末尾。
`AppendDocument(srcDoc: Document, importFormatMode: ImportFormatMode, importFormatOptions: ImportFormatOptions)`	将指定的文档追加到此文档的末尾。
`Save(fileName: string)`	保存文档。
`Save(fileName: string, saveFormat: SaveFormat)`	将文档保存为指定格式的文件。
`Save(fileName: string, saveOptions: SaveOptions)`	使用指定的保存选项将文档保存为文件。
`Save(stream: Stream, saveFormat: SaveFormat)`	重载使得可以将文档保存到文件名或流中，可选地指定保存格式或详细的保存选项
`Save(stream: Stream, saveOptions: SaveOptions)`	在此 Document 实例上调用 Save(stream, saveOptions)。
`Save(response: HttpResponse, fileName: string, contentDisposition: ContentDisposition, saveOptions: SaveOptions)`	将文档发送到客户端浏览器。
`EnsureMinimum()`	如果文档不包含任何节，则创建一个包含一个段落的节。
`AcceptAllRevisions()`	接受文档中所有的已跟踪更改。
`Protect(type: ProtectionType)`	防止文档被更改。
`Protect(type: ProtectionType, password: string)`	防止文档被更改，并可选地设置保护密码。
`Unprotect()`	移除文档的保护。
`Unprotect(password: string)`	如果指定了正确的密码，则移除文档的保护。
`UpdateTableLayout()`	实现了一种早期的表格列宽重新计算方法，但该方法已知存在问题。
`UpdateListLabels()`	更新文档中所有列表项的列表标签。
`UpdateActualReferenceMarks()`	更新文档中所有脚注和尾注的 ActualReferenceMark 属性。
`RemoveMacros()`	从文档中删除所有宏（VBA 项目）以及工具栏和命令自定义。
`UpdateFields()`	更新整个文档中字段的值。
`UnlinkFields()`	取消链接整个文档中的字段。
`NormalizeFieldTypes()`	更改整个文档中 FieldType 的字段类型值 FieldStart、FieldSeparator、FieldEnd，使其对应于字段代码中包含的字段类型。
`JoinRunsWithSameFormatting()`	在文档的所有段落中，将具有相同格式的 runs 合并。
`ExpandTableStylesToDirectFormatting()`	将表格样式中指定的格式转换为文档中表格的直接格式。
`Cleanup()`	清理文档中未使用的样式和列表。
`Cleanup(options: CleanupOptions)`	根据给定的 CleanupOptions 清理文档中未使用的样式和列表。
`RemoveExternalSchemaReferences()`	删除此文档中对外部 XML 架构的引用。
`StartTrackRevisions(author: string, dateTime: DateTime)`	自动开始以编程方式将您对文档所做的所有后续更改标记为修订更改。
`StartTrackRevisions(author: string)`	自动开始以编程方式将您对文档所做的所有后续更改标记为修订更改。
`StopTrackRevisions()`	停止自动将文档更改标记为修订。
`CopyStylesFromTemplate(template: string)`	将指定模板中的样式复制到文档中。
`CopyStylesFromTemplate(template: Document)`	将指定模板的样式复制到文档中。
`ImportNode(srcNode: Node, isImportChildren: bool)`	将节点从另一个文档导入到当前文档。
`GetText()`	获取此节点及其所有子节点的文本。
`GetChildNodes(nodeType: NodeType, isDeep: bool)`	返回匹配指定类型的子节点集合。
`GetChild(nodeType: NodeType, index: int, isDeep: bool)`	返回匹配指定类型的第 N 个子节点。
`SelectNodes(xpath: string)`	选择与 XPath 表达式匹配的节点列表。
`SelectSingleNode(xpath: string)`	选择匹配 XPath 表达式的第一个节点。
`GetEnumerator()`	提供对该节点子节点进行 foreach 风格迭代的支持。
`AppendChild(newChild: T)`	将指定的节点添加到该节点子节点列表的末尾。
`PrependChild(newChild: T)`	将指定节点添加到该节点的子节点列表的开头。
`InsertAfter(newChild: T, refChild: Node)`	在指定的参考节点之后立即插入指定节点。
`InsertBefore(newChild: T, refChild: Node)`	在指定的参考节点之前立即插入指定节点。
`RemoveChild(oldChild: T)`	移除指定的子节点。
`RemoveAllChildren()`	删除当前节点的所有子节点。
`RemoveSmartTags()`	删除当前节点的所有 SmartTag 后代节点。
`IndexOf(child: Node)`	返回子节点数组中指定子节点的索引。
`CreateNavigator()`	创建一个可用于遍历和读取节点的导航器。
`GetAncestor(ancestorType: Type)`	获取指定对象类型的第一个祖先。
`GetAncestorOf()`	在此 Document 实例上调用 GetAncestorOf。
`Remove()`	从父节点中移除自身。
`NextPreOrder(rootNode: Node)`	根据先序树遍历算法获取下一个节点。
`PreviousPreOrder(rootNode: Node)`	根据先序树遍历算法获取上一个节点。
`ToString(saveFormat: SaveFormat)`	将节点的内容导出为指定格式的字符串。
`NodeTypeToString(nodeType: NodeType)`	一个将节点类型枚举值转换为用户友好字符串的实用方法。

另请参阅

Aspose.Words for .NET — Enterprise API Reference