如何开始使用IronPDF C# PDF库

This article was translated from English: Does it need improvement?
Translated
View the article in English

IronPDF 是我们全面且多功能的软件库,可为您提供对项目或工作流程中生成、编辑和导出 PDF 文件的完全细致控制。 以及输出中的每个方面和细节。

这个强大的工具支持多种语言,例如 C#、F#、VB.NET、Java 等。 这是解决您PDF问题的最佳方案。 本文将介绍C# IronPDF 安装方法。

可通过NuGet和直接下载获取开发用免费软件。 按照以下说明开始在您的 .NET 项目中将 HTML 转换为 PDF。

立即在您的项目中开始使用IronPDF,并享受免费试用。

第一步:
green arrow pointer

如何安装IronPDF:选择正确的模式:本地 vs 远程

IronPDF 提供两种模式用于渲染 PDF——Native ModeRemote Mode——以适应不同的开发环境:

Native Mode:最佳选择是希望在本地运行所有内容的开发人员,适用于现代 Windows、macOS 和 Linux 部署。 只需安装以下软件包:

  • IronPdf

    远程模式 (IronPdfEngine):适合云和容器化环境,如 Azure、AWS 和 Docker,在这些环境中可以集中管理依赖项。 也非常适合本机不支持或遗留的操作系统,例如Windows Server 2012和不太流行的Linux发行版。 只需在您的项目中安装以下软件包并连接到IronPdfEngine容器:

  • IronPdf.Slim

使用IronPDF与远程引擎结合

请注意
Native与Engine的区别是什么?

IronPDF具有一些性能密集型功能,您可以选择远程运行。 虽然IronPDF不需要IronPdfEngine来运行,但将IronPdfEngine设置为远程服务是一种可选的方法,可避免在较旧的操作系统和移动环境中遇到特定平台的Chrome兼容性问题。

使用 Engine 如何改变我在使用 IronPDF 时的编码方式?

在使用引擎配置时,我们建议安装IronPdf.Slim而不是从NuGet中安装完整的IronPdf包,因为引擎会管理本机包中包含的所有额外内容。

PM> Install-Package IronPdf.Slim

安装IronPdf.Slim后,通过将IronPDF指向您的IronPdfEngine实例来配置连接设置。 在应用程序启动时添加以下代码(或在调用任何 IronPDF 方法之前):

// Assuming that IronPdfEngine runs
// remotely at 123.456.7.8:33350.
Installation.ConnectToIronPdfHost( IronPdf.GrpcLayer.IronPdfConnectionConfiguration.RemoteServer("123.456.7.8:33350"));
// Assuming that IronPdfEngine runs
// remotely at 123.456.7.8:33350.
Installation.ConnectToIronPdfHost( IronPdf.GrpcLayer.IronPdfConnectionConfiguration.RemoteServer("123.456.7.8:33350"));
' Assuming that IronPdfEngine runs
' remotely at 123.456.7.8:33350.
Installation.ConnectToIronPdfHost(IronPdf.GrpcLayer.IronPdfConnectionConfiguration.RemoteServer("123.456.7.8:33350"))
$vbLabelText   $csharpLabel

如何将IronPDF库安装到.NET项目(本机)中

安装C# PDF库简单方便,耗时不到5分钟。

通过 NuGet 和直接下载提供的免费开发软件,本教程将帮助您在 Visual Studio 中快速启动和运行。 按照以下说明开始在您的 .NET 项目中将 HTML 转换为 PDF。


教程

方法 1:通过 NuGet 安装 IronPDF

使用以下几个步骤从 Visual Studio 中安装 IronPDF NuGet 库

  1. 在解决方案资源管理器中,右击“引用”,管理NuGet包。

  2. 选择浏览并搜索IronPdf

  3. 选择软件包并安装。
Install-Package IronPdf

我们还提供适用于特定部署的IronPDF NuGet包,包括MacLinuxAzureDocker和AWS,这些均记录在我们的IronPDF高级NuGet安装指南中。


方法二:通过 DLL 下载安装 IronPDF

可以通过下载来安装IronPDF,这是第二种方法。 遵循以下简单快捷的步骤:

以下是针对特定平台的其他 IronPDF DLL 压缩包:

Operating SystemZIP Package
WindowsIronPdf.zip
LinuxIronPdf.Linux.zip
MacIronPdf.MacOs.zip
  • 下载并解压缩适合您操作系统的ZIP文件到您的解决方案目录中的~/Libs等位置。
  • 在 Visual Studio 解决方案资源管理器中,右键单击“依赖项”并选择“添加项目引用”。 选择“浏览”并包含从zip中提取的所有dll文件。

申请许可证密钥

在使用 IronPDF 之前,请在应用程序启动时包含此代码。 这种方法普遍有效且易于实施。

IronPdf.License.LicenseKey = "YOUR-IRONPDF-LICENSE-KEY";
IronPdf.License.LicenseKey = "YOUR-IRONPDF-LICENSE-KEY";
IronPdf.License.LicenseKey = "YOUR-IRONPDF-LICENSE-KEY"
$vbLabelText   $csharpLabel

如果您不想使用内联代码应用许可证密钥,请访问《IronPDF License Keys》文章以探索替代方法。


2. 授予文件或文件夹必要的访问权限

有时可能需要在您的电脑上为某些用户或角色添加权限。

例如,每个AppDomain都需要其自己的TempFolderPath,而同一个AppPool中的应用程序不能共享TempFolderPath。

现在这是什么意思?

AppDomain 只是在特定进程内提供一个隔离层。 您认为的每个程序实际上是每个AppDomain。 每个位于同一应用程序池中的应用程序都需要拥有自己的临时文件夹,以便完全独立地运行。

如有必要,您可以按以下方式设置权限:

  1. 右键单击文件或文件夹

  2. 选择属性

  3. 选择安全性

  4. 点击编辑...

  5. 选择所需的权限。


3. 设置安装路径

要将HTML 渲染为 PDF,IronPDF 必须嵌入 Chromium,这是一种安全的网络浏览器。 幸运的是,这个过程是完全自动化的。

如果IronPDF的HTML转PDF遇到“渲染失败”的异常,这种情况虽然很罕见,但您可能需要将本地浏览器的二进制文件解压到适当的位置。 临时文件夹通常是理想的选择。

注意:程序文件永远不是一个合适的位置。

设置 IronPdf.Installation.TempFolderPath

您可以通过设置 IronPdf.Installation 对象的 TempFolderPath 属性来解压到正确的位置,如下所示:

IronPdf.Installation.TempFolderPath = @"C:\My\Safe\Path";

在更新路径后,始终记得清除开发环境和服务器上的所有临时文件和缓存文件夹。 重新部署您的应用程序的干净版本。

在应用程序范围设置临时文件夹环境变量

IronPDF在渲染和编辑PDF文档时可能会偶尔在系统临时文件夹中生成临时文件。 我们也可以设置 IronPdf.Installation.TempFolderPath 来解决这个问题,但环境 TempPath 目录有时仍可能被第三方包使用。

为了解决此问题,我们可以在 C# 应用程序启动时将 TempPath 环境变量设置为应用程序范围。这确保了应用程序创建的所有临时文件都存储在一个可控位置。

using IronPdf;

// Set Application scope Temp Files Path.
// This changes System.IO.Path.GetTempFileName and System.IO.Path.GetTempPath behavior for the entire .NET application
var MyTempPath = @"C:\Safe\Path\";
Environment.SetEnvironmentVariable("TEMP", MyTempPath, EnvironmentVariableTarget.Process);
Environment.SetEnvironmentVariable("TMP", MyTempPath, EnvironmentVariableTarget.Process);

// Set IronPDF Temp Path
IronPdf.Installation.TempFolderPath = System.IO.Path.Combine(MyTempPath, "IronPdf");

// Your PDF Generation and editing code here..E.G.
var Renderer = new IronPdf.ChromePdfRenderer();
using var Doc = Renderer.RenderHtmlAsPdf("<h1>Html with CSS and Images</h1>");
Doc.SaveAs("example.pdf");
using IronPdf;

// Set Application scope Temp Files Path.
// This changes System.IO.Path.GetTempFileName and System.IO.Path.GetTempPath behavior for the entire .NET application
var MyTempPath = @"C:\Safe\Path\";
Environment.SetEnvironmentVariable("TEMP", MyTempPath, EnvironmentVariableTarget.Process);
Environment.SetEnvironmentVariable("TMP", MyTempPath, EnvironmentVariableTarget.Process);

// Set IronPDF Temp Path
IronPdf.Installation.TempFolderPath = System.IO.Path.Combine(MyTempPath, "IronPdf");

// Your PDF Generation and editing code here..E.G.
var Renderer = new IronPdf.ChromePdfRenderer();
using var Doc = Renderer.RenderHtmlAsPdf("<h1>Html with CSS and Images</h1>");
Doc.SaveAs("example.pdf");
Imports IronPdf

' Set Application scope Temp Files Path.
' This changes System.IO.Path.GetTempFileName and System.IO.Path.GetTempPath behavior for the entire .NET application
Private MyTempPath = "C:\Safe\Path\"
Environment.SetEnvironmentVariable("TEMP", MyTempPath, EnvironmentVariableTarget.Process)
Environment.SetEnvironmentVariable("TMP", MyTempPath, EnvironmentVariableTarget.Process)

' Set IronPDF Temp Path
IronPdf.Installation.TempFolderPath = System.IO.Path.Combine(MyTempPath, "IronPdf")

' Your PDF Generation and editing code here..E.G.
Dim Renderer = New IronPdf.ChromePdfRenderer()
Dim Doc = Renderer.RenderHtmlAsPdf("<h1>Html with CSS and Images</h1>")
Doc.SaveAs("example.pdf")
$vbLabelText   $csharpLabel

4. 权限和 IIS

如果服务器已被锁定,您可能需要为 IIS 用户 (IUSER) 授予对安装路径文件夹以及 Windows 和 Temp 文件夹的读写权限。


5. 微软Visual C++和Windows兼容性

IronPDF需要在目标Windows机器上安装Microsoft Visual C++。如有必要,可以将其与应用程序安装程序(如MSI)一起打包。

Microsoft Visual C++ 是 Windows 组件,通常存在于现代版本的 Windows 中,除非它们被有意精简。

.NET Framework 可以以 32 位运行(即使在 64 位平台上),因此有必要安装 Visual C++ 的 32 位和 64 位版本。

在此,您可以下载 Microsoft Visual C++


6. Linux 兼容性

7. Docker 兼容性

8. Azure 兼容性

9. 亚马逊 AWS Lambda 兼容性

10. macOS 兼容性