Class Document
内容
[
隐藏
]Document 类
表示 PDF 文档的类。
public sealed class Document : IDisposable
构造函数
| 名称 | 描述 |
|---|---|
| Document() | 初始化空文档。 |
| Document(PdfVersion) | 按版本初始化空文档。 |
| Document(Stream) | 从 input 流初始化新的 Document 实例。 |
| Document(string) | 仅使用 filename 初始化 Document。与 Document 相同。 |
| Document(Stream, bool) | 从 input 流初始化新的 Document 实例。 |
| Document(Stream, LoadOptions) | 从流打开现有文档，提供必要的转换以获取 PDF 文档。 |
| Document(Stream, string) | 从 input 流初始化新的 Document 实例。 |
| Document(string, bool) | 仅使用 filename 初始化 Document。与 Document 相同。 |
| Document(string, LoadOptions) | 从文件打开现有文档，提供必要的转换选项以获取 PDF 文档。 |
| Document(string, string) | 初始化用于处理加密文档的 Document 类的新实例。 |
| Document(Stream, string, bool) | 从 input 流初始化新的 Document 实例。 |
| Document(string, string, bool) | 初始化用于处理加密文档的 Document 类的新实例。 |
属性
| 名称 | 描述 |
|---|---|
| Actions { get; } | 获取文档操作。此属性是 DocumentActions 类的实例，允许获取/设置 BeforClosing、BeforSaving 等操作。 |
| AllowReusePageContent { get; set; } | 允许合并页面内容以优化文档大小。如果使用，则不同但重复的页面可能引用相同的内容对象。请注意，此模式可能会导致副作用，例如在其他页面更改时更改页面内容。 |
| Background { get; set; } | 获取或设置文档的背景颜色。 |
| CenterWindow { get; set; } | 获取或设置标志，指定文档窗口的位置是否应居中于屏幕。 |
| Collection { get; set; } | 获取文档集合。 |
| CryptoAlgorithm { get; } | 获取安全设置，如果文档被加密。如果文档未加密，则在 .net 1.1 中将引发相应异常，或在其他 .net 版本中 CryptoAlgorithm 将为 null。 |
| Destinations { get; } | 获取目标集合。已过时。请使用 NamedDestinations。 |
| Direction { get; set; } | 获取或设置文本的阅读顺序：L2R（从左到右）或 R2L（从右到左）。 |
| DisableFontLicenseVerifications { get; set; } | 如果这些操作被该字体的许可证禁止，则无法执行许多与字体相关的操作。例如，如果许可证规则禁用该字体的嵌入，则某些字体无法嵌入到 PDF 文档中。此标志用于禁用当前 PDF 文档中所有字体的任何许可证限制。使用此标志时请小心。当设置此标志时，意味着设置此标志的人承担所有可能的许可证/法律违规责任。因此，他自担风险。强烈建议仅在您完全确信不会违反版权法时使用此标志。默认值为 false。 |
| DisplayDocTitle { get; set; } | 获取或设置标志，指定文档的窗口标题栏是否应显示文档标题。 |
| Duplex { get; set; } | 获取或设置打印双面模式处理选项，以便在从打印对话框打印文件时使用。 |
| EmbeddedFiles { get; } | 获取嵌入到文档中的文件集合。 |
| EmbedStandardFonts { get; set; } | 声明文档必须嵌入所有标准 Type1 字体的属性，该字体的 IsEmbedded 标志设置为 true。所有 PDF 字体可以通过将 IsEmbedded 标志设置为 true 简单地嵌入到文档中，但 PDF 标准 Type1 字体是此规则的例外。标准 Type1 字体的嵌入需要大量时间，因此要嵌入这些字体，不仅需要将指定字体的 IsEmbedded 标志设置为 true，还需要在文档级别设置附加标志 - EmbedStandardFonts = true；此属性只能为所有字体设置一次。默认值为 false。 |
| EnableObjectUnload { get; set; } | 获取或设置标志，允许文档部分从内存中卸载。这允许减少内存使用，但可能对性能产生负面影响。 |
| EnableSignatureSanitization { get; set; } | 获取或设置标志以管理签名字段的清理。默认启用。 |
| FileName { get; } | 导致此文档的 PDF 文件的名称 |
| FitWindow { get; set; } | 获取或设置标志，指定文档窗口是否必须调整大小以适应第一个显示的页面。 |
| FontUtilities { get; } | IDocumentFontUtilities 实例 |
| Form { get; } | 获取文档的 Acro 表单。 |
| HandleSignatureChange { get; set; } | 如果文档将保存更改并具有签名，则抛出异常 |
| HideMenubar { get; set; } | 获取或设置标志，指定文档处于活动状态时菜单栏是否应隐藏。 |
| HideToolBar { get; set; } | 获取或设置标志，指定文档处于活动状态时工具栏是否应隐藏。 |
| HideWindowUI { get; set; } | 获取或设置标志，指定文档处于活动状态时用户界面元素是否应隐藏。 |
| Id { get; } | 获取 ID。 |
| IgnoreCorruptedObjects { get; set; } | 获取或设置忽略源文件中错误的标志。当源文档中的页面复制到目标文档时，如果源文件中的某些对象损坏，则复制过程将停止并引发异常（当此标志为 false 时）。例如：dest.Pages.Add(src.Pages); 如果此标志设置为 true，则损坏的对象将被空值替换。默认值：true。 |
| Info { get; } | 获取文档信息。 |
| IsEncrypted { get; } | 获取文档的加密状态。如果文档被加密，则为 true。 |
| IsLinearized { get; set; } | 获取或设置一个值，指示文档是否已线性化。 |
| IsPdfaCompliant { get; } | 获取文档是否符合 pdfa 标准。 |
| IsPdfUaCompliant { get; } | 获取文档是否符合 pdfua 标准。 |
| IsXrefGapsAllowed { get; set; } | 获取或设置文档是否允许 xref 间隙。 |
| JavaScript { get; } | 文档级的 JavaScript 集合。 |
| LogicalStructure { get; } | 获取文档的逻辑结构。 |
| Metadata { get; } | 文档元数据。（PDF 文档可以包含一般信息，例如文档的标题、作者以及创建和修改日期。关于文档的此类全局信息（与其内容或结构相对）称为元数据，旨在帮助在外部数据库中对文档进行分类和搜索。） |
| NamedDestinations { get; } | 文档中命名目标的集合。 |
| NonFullScreenPageMode { get; set; } | 获取或设置页面模式，指定在退出全屏模式时如何显示文档。 |
| OpenAction { get; set; } | 获取或设置在文档打开时执行的操作。 |
| OptimizeSize { get; set; } | 获取或设置优化标志。当页面添加到文档时，如果设置了此标志，则结果文件中的相等资源流将合并为一个 PDF 对象。这允许减少结果文件的大小，但可能导致执行速度变慢和更大的内存需求。默认值：false。 |
| Outlines { get; } | 获取文档大纲。 |
| OutputIntents { get; } | 获取文档中的输出意图集合。 |
| PageInfo { get; set; } | 获取或设置页面信息。（仅适用于生成器，读取文档时未填充） |
| PageLabels { get; } | 获取文档中的页面标签。 |
| PageLayout { get; set; } | 获取或设置在打开文档时应使用的页面布局。 |
| PageMode { get; set; } | 获取或设置页面模式，指定打开文档时应如何显示文档。 |
| Pages { get; } | 获取或设置文档页面的集合。请注意，集合中的页面编号从 1 开始。 |
| PdfFormat { get; } | 获取 PDF 格式 |
| Permissions { get; } | 获取文档的权限。 |
| PickTrayByPdfSize { get; set; } | 获取或设置一个标志，指定是否应使用 PDF 页面大小来选择输入纸盘。 |
| PrintScaling { get; set; } | 获取或设置在显示此文档的打印对话框时应选择的页面缩放选项。 |
| TaggedContent { get; } | 获取对 TaggedPdf 内容的访问。 |
| Version { get; } | 获取 PDF 文件头中的 PDF 版本。 |
| static FileSizeLimitToMemoryLoading { get; set; } | 获取和设置加载整个文件到内存的文件大小限制。该值以兆字节为单位。默认值为 210 Mb。 |
| static IsLicensed { get; } | 获取系统的许可状态。返回 true 表示系统在许可模式下工作，false 则表示不是。 |
方法
| 名称 | 描述 |
|---|---|
| static MergeDocuments(params Document[]) | 合并文档。 |
| static MergeDocuments(params string[]) | 合并 PDF 文件。 |
| static MergeDocuments(MergeOptions, params Document[]) | 合并文档。 |
| static MergeDocuments(MergeOptions, params string[]) | 合并文档。 |
| BindXml(Stream) | 将 XML 绑定到文档 |
| BindXml(string) | 将 XML 绑定到文档 |
| BindXml(Stream, Stream) | 将 XML/XSL 绑定到文档 |
| BindXml(string, string) | 将 XML/XSL 绑定到文档 |
| BindXml(Stream, Stream, XmlReaderSettings) | 将 XML/XSL 绑定到文档 |
| ChangePasswords(string, string, string) | 更改文档密码。此操作只能使用所有者密码完成。 |
| Check(bool) | 验证文档。 |
| Convert(PdfFormatConversionOptions) | 使用指定的转换选项转换文档 |
| Convert(CallBackGetHocr, bool) | 识别文档中的图像并在其上添加 hocr 字符串。 |
| Convert(CallBackGetHocrWithPage, bool) | 识别文档中的图像并在其上添加 hocr 字符串。 |
| Convert(Stream, PdfFormat, ConvertErrorAction) | 转换文档并将错误保存到指定流中。 |
| Convert(string, PdfFormat, ConvertErrorAction) | 转换文档并将错误保存到指定文件中。 |
| Convert(Fixup, Stream, bool, object[]) | 通过应用 Fixup 转换文档。 |
| Convert(Fixup, string, bool, object[]) | 通过应用 Fixup 转换文档。 |
| Convert(Stream, PdfFormat, ConvertErrorAction, ConvertTransparencyAction) | 转换文档并将错误保存到指定文件中。 |
| Convert(string, PdfFormat, ConvertErrorAction, ConvertTransparencyAction) | 转换文档并将错误保存到指定文件中。 |
| ConvertPageToPNGMemoryStream(Page) | 将页面转换为 PNG 以用于 DSR、OMR、OCR 图像流。 |
| Decrypt() | 解密文档。然后调用 Save 以获取文档的解密版本。 |
| Dispose() | 关闭此文档使用的所有资源。 |
| Encrypt(string, string, Permissions, CryptoAlgorithm) | 加密文档。然后调用 Save 以获取文档的加密版本。 |
| Encrypt(string, string, DocumentPrivilege, CryptoAlgorithm, bool) | 加密文档。然后调用 Save 以获取文档的加密版本。 |
| Encrypt(string, string, Permissions, CryptoAlgorithm, bool) | 加密文档。然后调用 Save 以获取文档的加密版本。 |
| ExportAnnotationsToXfdf(Stream) | 将所有文档注释导出到流中。 |
| ExportAnnotationsToXfdf(string) | 将所有文档注释导出到 XFDF 文件 |
| Flatten() | 从文档中删除所有字段并替换其值。 |
| Flatten(FlattenSettings) | 从文档中删除所有字段（和注释）并替换其值。 |
| FlattenTransparency() | 用不透明的光栅和矢量图形替换透明内容。 |
| FreeMemory() | 清除内存 |
| GetCatalogValue(string) | 从目录字典返回项目值。 |
| GetObjectById(string) | 获取文档中具有指定 ID 的对象。 |
| GetXmpMetadata(Stream) | 从文档获取 XMP 元数据。 |
| HasIncrementalUpdate() | 检查当前 PDF 文档是否已保存增量更新。 |
| ImportAnnotationsFromXfdf(Stream) | 从流导入注释到文档。 |
| ImportAnnotationsFromXfdf(string) | 从 XFDF 文件导入注释到文档。 |
| IsRepairNeeded(out RepairOptions) | 检查文档是否需要调用 Repair 方法。 |
| LoadFrom(string, LoadOptions) | 加载文件，将其转换为 PDF。 |
| Merge(params Document[]) | 合并文档。 |
| Merge(params string[]) | 合并 PDF 文件。 |
| Merge(MergeOptions, params Document[]) | 合并文档。 |
| Merge(MergeOptions, params string[]) | 合并文档。 |
| Optimize() | 线性化文档以便 - 尽快打开第一页； - 尽快显示下一页或跟随链接到下一页； - 在数据通过慢通道传输时逐步显示页面（首先显示最有用的数据）； - 允许用户交互，例如在整个页面接收和显示之前执行跟随链接的操作。调用此方法实际上并不会保存文档。相反，文档仅准备好具有优化结构，然后调用 Save 以获取优化文档。 |
| OptimizeResources() | 优化文档中的资源：1. 删除文档页面上未使用的资源；2. 将相等资源合并为一个对象；3. 删除未使用的对象。 |
| OptimizeResources(OptimizationOptions) | 根据定义的优化策略优化文档中的资源。 |
| PageNodesToBalancedTree(byte) | 将文档中的页面树节点组织成平衡树。仅当文档中有超过 nodesNumInSubtrees 的页面对象时，否则不执行任何操作。在迭代 Pages 元素时不要调用此方法，它可能会产生不可预测的结果。 |
| ProcessParagraphs() | 为生成器处理段落。 |
| RemoveMetadata() | 从文档中删除元数据。 |
| RemovePdfaCompliance() | 从文档中删除 pdfa 合规性 |
| RemovePdfUaCompliance() | 从文档中删除 pdfUa 合规性 |
| Repair(RepairOptions) | 修复损坏的文档。 |
| Save() | 以增量方式保存文档（即使用增量更新技术）。 |
| Save(SaveOptions) | 使用保存选项保存文档。 |
| Save(Stream) | 将文档存储到流中。 |
| Save(string) | 将文档保存到指定文件中。 |
| Save(Stream, SaveFormat) | 以新名称和文件格式保存文档。 |
| Save(Stream, SaveOptions) | 使用保存选项将文档保存到流中。 |
| Save(string, SaveFormat) | 以新名称和文件格式保存文档。 |
| Save(string, SaveOptions) | 以新名称保存文档并设置其保存选项。 |
| SaveAsync(CancellationToken) | 以增量方式保存文档（即使用增量更新技术）。 |
| SaveAsync(SaveOptions, CancellationToken) | 使用保存选项保存文档。 |
| SaveAsync(Stream, CancellationToken) | 将文档存储到流中。 |
| SaveAsync(string, CancellationToken) | 将文档保存到指定文件中。 |
| SaveAsync(Stream, SaveFormat, CancellationToken) | 以新名称和文件格式保存文档。 |
| SaveAsync(Stream, SaveOptions, CancellationToken) | 使用保存选项将文档保存到流中。 |
| SaveAsync(string, SaveFormat, CancellationToken) | 以新名称和文件格式保存文档。 |
| SaveAsync(string, SaveOptions, CancellationToken) | 以新名称保存文档并设置其保存选项。 |
| SaveXml(string) | 将文档保存为 XML。 |
| SendTo(DocumentDevice, Stream) | 将整个文档发送到文档设备进行处理。 |
| SendTo(DocumentDevice, string) | 将整个文档发送到文档设备进行处理。 |
| SendTo(DocumentDevice, int, int, Stream) | 将文档的某些页面发送到文档设备进行处理。 |
| SendTo(DocumentDevice, int, int, string) | 将整个文档发送到文档设备进行处理。 |
| SetTitle(string) | 为 PDF 文档设置标题 |
| SetXmpMetadata(Stream) | 设置文档的 XMP 元数据。 |
| Validate(PdfFormatConversionOptions) | 将文档验证到指定文件。 |
| Validate(Stream, PdfFormat) | 将文档验证到指定文件。 |
| Validate(string, PdfFormat) | 将文档验证到指定文件。 |
| static Convert(Stream, LoadOptions, Stream, SaveOptions) | 将源格式中的流转换为目标格式中的流。 |
| static Convert(Stream, LoadOptions, string, SaveOptions) | 将源格式中的流转换为目标格式中的目标文件。 |
| static Convert(string, LoadOptions, Stream, SaveOptions) | 将源文件中的源格式转换为目标格式中的流。 |
| static Convert(string, LoadOptions, string, SaveOptions) | 将源文件中的源格式转换为目标格式中的目标文件。 |
| static SetDefaultFileSizeLimitToMemoryLoading() | 将加载整个文件到内存的文件大小限制设置为默认值210 Mb。 |
字段
| 名称 | 描述 |
|---|---|
| const DefaultNodesNumInSubtrees |
事件
| 名称 | 描述 |
|---|---|
| event FontSubstitution | 当字体在文档中替换另一个字体时发生。 |
其他成员
| 名称 | 描述 |
|---|---|
| delegate CallBackGetHocr | |
| delegate CallBackGetHocrWithPage | |
| delegate FontSubstitutionHandler | 表示将处理 FontSubstitution 事件的方法。 |
| interface IDocumentFontUtilities | 持有调整字体的功能 |
| class MergeOptions | 表示合并方法的选项。 |
| class RepairOptions | 表示修复 PDF 文档的选项。 |
另请参阅
- namespace Aspose.Pdf
- assembly Aspose.PDF
