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

入门

本文介绍一些基础内容,帮助你开始使用 Docotic.Pdf 库,在 .NET Core、ASP.NET、Windows Forms、WPF、Xamarin、Blazor、Unity 和 HoloLens 应用程序中处理 PDF 文件。

Docotic.Pdf 入门

安装 Docotic.Pdf 库

从 NuGet 安装

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

如果你是 NuGet Manager 新手,请参阅这篇 快速入门文章

手动安装

下载最新版本的 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 to PDF API 的更多信息,请阅读 其功能概览。这篇文章解释了如何从 NuGet 安装该附加组件或手动安装。它还包含示例代码。

Layout 附加组件

使用 Layout 附加组件从结构化布局元素生成 PDF。你可以将文档组合为文本片段、图像、表格、页眉、页脚、容器,以及可选的可复用自定义组件,流式 Layout API 会为你安排好一切。

你无需将元素放在固定坐标上,而是使用简洁、表达力强的 API 在代码中描述完整文档,使布局自动适应内容和页面大小。布局引擎随后会自动处理分页、嵌套和复杂结构。这使你可以轻松生成从简单页面到复杂 PDF 报告的各种内容。

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

Gdi 附加组件

可用于打印 PDF 文档或在 System.Drawing.Graphics 上绘制 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 博客