如何開始使用 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:選擇合適的模式:本地與遠端

IronPDF 提供兩種模式來渲染 PDF──原生模式遠端模式──以適應不同的開發環境:

本機模式:最適合希望在本地運行所有內容的開發人員,適用於現代 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 的程式編寫方式?

在使用引擎配置時,我們建議從 NuGet 安裝 IronPdf.Slim 而不是完整的 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。


如何操作教程

方法一:通過 NuGet 安裝 IronPDF

請按照以下步驟從 Visual Studio 中安裝IronPDF NuGet 庫

  1. 在解決方案總管中,右鍵點擊 參考,管理 NuGet 包裹。

  2. 選擇瀏覽並搜尋IronPdf

  3. 選擇套件並安裝。
Install-Package IronPdf

我們的IronPDF 高級 NuGet 安裝指南中記錄了 IronPDF NuGet 套件可用於特定部署至MacLinuxAzureDocker和 AWS。


方法二:透過下載 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 拋出“渲染失敗”的例外,這種情況非常罕見,您可能需要將原生瀏覽器二進制文件解壓到適當的位置。 Temp 資料夾通常是理想的選擇。

注意:永遠不要將程式檔案放置在 Program Files 資料夾中。

設定 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. Microsoft Visual C++ 與 Windows 兼容性

IronPDF 需要在目標 Windows 機器上安裝 Microsoft Visual C++。如有必要,可以將其與應用程式安裝程式(例如 MSI)一起打包。

Microsoft Visual C++ 是一個 Windows 組件,通常在現代版本的 Windows 上都會有,除非它們被故意精簡過。

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

您可以在此處下載 Microsoft Visual C++


6. Linux 兼容性

7. Docker 兼容性

8. Azure 兼容性

9. 亞馬遜 AWS Lambda 兼容性

10. macOS 兼容性