该页面可以包含自动翻译的文本。

入门

本文介绍了一些基础知识,帮助您快速上手,在 .NET Core、ASP.NET、Windows Forms、WPF、Xamarin、Blazor、Unity 和 HoloLense 应用程序中使用 Docotic.Pdf 库处理 PDF 文件。

Docotic.Pdf入门指南

安装 Docotic.Pdf 库

通过 NuGet 安装

最简单的入门方法是从 NuGet 安装 BitMiracle.Docotic.Pdf 包

如果您是 NuGet 管理器的新手,请参阅这篇快速入门文章

手动安装

请从我们的网站下载最新版本的 Docotic.Pdf 库。我们以 ZIP 压缩包的形式分发该库。该压缩包包含 Docotic.Pdf 库、所有示例代码项目、库插件和许可协议。

将下载的 ZIP 包解压到您选择的位置。

在 Visual Studio 中,打开“添加引用”对话框,浏览到您解压缩 ZIP 包的位置,然后从那里选择 DLL 文件。

使用“添加引用”对话框添加 Docotic.Pdf

运行示例代码

Docotic.Pdf 的代码示例位于 ZIP 包的 Samples 文件夹中。如果您想使用 C# 语言编写的示例代码,请打开 SamplesCSharp 解决方案文件。对于 VB.NET 版本,请打开 SamplesVB.NET 解决方案文件。

您可以从我们在GitHub上的示例代码库克隆或下载相同的代码示例。

请花些时间查看代码示例。它应该能帮助您为应用程序添加 PDF 处理功能。

在您的 .NET 项目中使用 Docotic.Pdf

为了避免输入库提供的类型的完全限定名称,最好将以下 using 指令添加到您的 C# 源文件中:

using BitMiracle.Docotic.Pdf;

在 VB.NET 中,请使用以下代码:

Imports BitMiracle.Docotic.Pdf

在 C# 项目中,将以下方法添加到应用程序源代码中:

private static void helloPdf()
{
    // 将 string.Empty 替换为您的许可证密钥
    BitMiracle.Docotic.LicenseManager.AddLicenseData(string.Empty);

    string outputName = "hello.pdf";
    // 在 ASP.NET 应用程序中,请使用以下代码行代替:
    // string outputName = Server.MapPath("hello.pdf");

    using (PdfDocument pdf = new PdfDocument())
    {
        // 在第一页画上“Hello world”。
        PdfPage firstPage = pdf.Pages[0];
        firstPage.Canvas.DrawString(20, 20, "Hello world!");

        pdf.Save(outputName);
    }

    // 在默认 PDF 查看器中打开已保存的文档
    System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo() {
        FileName = outputName,
        UseShellExecute = true,
    });
}

在 VB.NET 项目中,使用以下代码:

Private Shared Sub helloPdf()
    ' 将 string.Empty 替换为您的许可证密钥
    BitMiracle.Docotic.LicenseManager.AddLicenseData(String.Empty)

    Dim outputName As String = "hello.pdf"
    ' 在 ASP.NET 应用程序中,请改用以下代码行:
    ' Dim outputName As String = Server.MapPath("hello.pdf")

    Using pdf As New PdfDocument()
        ' 在第一页画上“Hello world”。
        Dim firstPage As PdfPage = pdf.Pages(0)
        firstPage.Canvas.DrawString(20, 20, "Hello world!")

        pdf.Save(outputName)
    End Using

    ' 在默认 PDF 查看器中打开已保存的文档
    System.Diagnostics.Process.Start(
        New ProcessStartInfo() With {
            .FileName = outputName,
            .UseShellExecute = True
        }
    )
End Sub

在你的代码中调用 helloPdf 方法。这应该会生成 hello.pdf 文件,并在你的默认 PDF 查看器中打开它。

在默认 PDF 查看器中打开 hello.pdf

附加组件

您可以通过免费插件扩展核心功能。

HtmlToPdf 插件

使用 HtmlToPdf 插件可以将 HTML 转换为 PDF。该插件基于 Google Chrome 浏览器及其 Blink 渲染引擎,因此对 HTML5、CSS3 和 JavaScript 的支持非常出色。您可以使用该插件从 HTML、SVG、WEBP 和其他 Web 格式生成 PDF。

如需了解该插件提供的 HTML 转 PDF API 的更多信息,请阅读功能概述。该文章介绍了如何通过 NuGet 或手动安装该插件,并包含示例代码。

Layout 插件

使用 Layout 插件可以从结构化布局元素生成 PDF。您可以利用文本跨度、图像、表格、页眉、页脚、容器以及(可选的)可重用自定义组件来构建文档,流畅的 Layout API 会自动为您安排所有内容。

您无需将元素放置在固定坐标,而是使用简洁、富有表现力的 API,通过代码描述整个文档,该 API 可根据内容和页面大小自动调整布局。布局引擎随后会自动处理分页、嵌套和复杂结构。这使得生成从简单页面到复杂 PDF 报告的各种内容变得轻而易举。

有关使用 Layout API 在 .NET 中生成 PDF 的更多信息,请阅读本文,其中深入解释了其功能,并包含安装说明和示例代码。

Gdi插件

允许您在 System.Drawing.Graphics 上打印 PDF 文档或绘制 PDF。您可以从 NuGet 安装 BitMiracle.Docotic.Pdf.Gdi 包。或者,您可以手动添加对 ZIP 包中以下 DLL 的引用:

  • BitMiracle.Docotic.Pdf.dll
  • Gdi add-on/BitMiracle.Docotic.Pdf.Gdi.dll

Logging 插件

您可以使用它来记录 PDF 文档的内部结构信息。从 NuGet 安装 BitMiracle.Docotic.Pdf.Logging 包。或者,手动添加对 ZIP 包中以下 DLL 的引用:

  • BitMiracle.Docotic.Pdf.dll
  • Logging add-on/BitMiracle.Docotic.Pdf.Logging.dll
  • Logging add-on/Microsoft.Extensions.Logging.Abstractions.dll

结论

现在,您应该能够使用 Docotic.Pdf 库在您的应用程序中开发与 PDF 相关的功能了。但这仅仅是个开始。我们建议您阅读有关该库的功能并查看代码示例。您可能还想访问Bit Miracle 博客