IronPDF 快速入门指南
安装 IronPDF,五分钟内即可创建您的第一个 PDF 文件。借助其简单的 API,您可以将 HTML、DOCX、图像等内容转换为像素级精准的 PDF 文件。
1. 先决条件
- .NET Framework 4.6.2+ 或 .NET Core 3.1+ 或 .NET 5+
- Visual C++ 再发行包(适用于 Windows)。
2. 安装 IronPDF
标准版 IronPDF 安装为本地运行。 若需在 Docker/微服务环境中部署,请参阅《远程引擎模式指南》。
- 在"解决方案资源管理器"中,右键单击"引用"
- 选择"管理 NuGet 包" > "浏览" > 搜索 IronPDF
Install-Package IronPdf
- 下载 IronPDF DLL 软件包
- 将适用于您操作系统的 ZIP 文件解压到解决方案目录内的某个位置
- 在 Visual Studio 解决方案资源管理器中,右键单击"依赖项"
- '添加项目引用' > 选择 '浏览' 以包含从 ZIP 文件中提取的所有 DLL 文件。
平台专用指南
3. 应用许可证密钥
当您购买 IronPDF 许可证或选择开始 30天试用时,许可证密钥将发送至您的电子邮箱。 复制密钥并将其添加到应用程序的开头。
IronPdf.License.LicenseKey = "YOUR-IRONPDF-LICENSE-KEY";
IronPdf.License.LicenseKey = "YOUR-IRONPDF-LICENSE-KEY";
IronPdf.License.LicenseKey = "YOUR-IRONPDF-LICENSE-KEY"
4. 创建您的第一个 PDF
请将此代码添加到 .cs 文件的顶部。
using IronPdf;
using IronPdf;
Imports IronPdf
创建 PDF 对象的最简单方法只需指定宽度和高度。 此 PdfDocument 构造函数会创建一个空白 PDF,可供后续自定义。
using IronPdf;
PdfDocument pdf = new PdfDocument(270, 270);
pdf.SaveAs("blankPage.pdf");
using IronPdf;
PdfDocument pdf = new PdfDocument(270, 270);
pdf.SaveAs("blankPage.pdf");
Imports IronPdf
Dim pdf As New PdfDocument(270, 270)
pdf.SaveAs("blankPage.pdf")
using ChromePdfRenderer.RenderHtmlAsPdf 方法,您可以通过内置的 Chromium 引擎将任何 HTML(包括 HTML5)转换为 PDF。
using IronPdf;
IronPdf.ChromePdfRender
.StaticRenderHtmlAsPdf("<p>Hello Word</p>")
.SaveAs("string-to-pdf.pdf");
using IronPdf;
IronPdf.ChromePdfRender
.StaticRenderHtmlAsPdf("<p>Hello Word</p>")
.SaveAs("string-to-pdf.pdf");
Imports IronPdf
IronPdf.ChromePdfRender.StaticRenderHtmlAsPdf("<p>Hello Word</p>").SaveAs("string-to-pdf.pdf")
using DocxToPdfRenderer 类将 WORD 文档转换为 PDF,您可以将 DOCX 文件直接渲染为可自定义的 PDF,从而无缝集成到 .NET 应用程序中。
using IronPdf;
DocxToPdfRenderer renderer = new DocxToPdfRenderer();
PdfDocument pdf = renderer.RenderDocxAsPdf("Modern-chronological-resume.docx");
pdf.SaveAs("pdfFromDocx.pdf");
using IronPdf;
DocxToPdfRenderer renderer = new DocxToPdfRenderer();
PdfDocument pdf = renderer.RenderDocxAsPdf("Modern-chronological-resume.docx");
pdf.SaveAs("pdfFromDocx.pdf");
Imports IronPdf
Private renderer As New DocxToPdfRenderer()
Private pdf As PdfDocument = renderer.RenderDocxAsPdf("Modern-chronological-resume.docx")
pdf.SaveAs("pdfFromDocx.pdf")
5. 更多高级示例
除了简单的 PDF 创建和转换功能外,IronPDF 还提供了更强大的 PDF 自定义选项。
通过实例化 TextHeaderFooter、添加文本并将其附加到 PDF 中,即可创建文本页眉或页脚。
using IronPdf;
ChromePdfRenderer renderer = new ChromePdfRenderer();
PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>");
// Create text header
TextHeaderFooter textHeader = new TextHeaderFooter
{
CenterText = "This is the header!",
};
// Create text footer
TextHeaderFooter textFooter = new TextHeaderFooter
{
CenterText = "This is the footer!",
};
// Add text header and footer to the PDF
pdf.AddTextHeaders(textHeader);
pdf.AddTextFooters(textFooter);
pdf.SaveAs("addTextHeaderFooter.pdf");
using IronPdf;
ChromePdfRenderer renderer = new ChromePdfRenderer();
PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>");
// Create text header
TextHeaderFooter textHeader = new TextHeaderFooter
{
CenterText = "This is the header!",
};
// Create text footer
TextHeaderFooter textFooter = new TextHeaderFooter
{
CenterText = "This is the footer!",
};
// Add text header and footer to the PDF
pdf.AddTextHeaders(textHeader);
pdf.AddTextFooters(textFooter);
pdf.SaveAs("addTextHeaderFooter.pdf");
Imports IronPdf
Dim renderer As New ChromePdfRenderer()
Dim pdf As PdfDocument = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>")
' Create text header
Dim textHeader As New TextHeaderFooter With {
.CenterText = "This is the header!"
}
' Create text footer
Dim textFooter As New TextHeaderFooter With {
.CenterText = "This is the footer!"
}
' Add text header and footer to the PDF
pdf.AddTextHeaders(textHeader)
pdf.AddTextFooters(textFooter)
pdf.SaveAs("addTextHeaderFooter.pdf")
using RedactTextOnAllPages 轻松处理文本,以在整个文档中删除特定短语。
using IronPdf;
PdfDocument pdf = PdfDocument.FromFile("novel.pdf");
// Redact 'Alaric' phrase from all pages
pdf.RedactTextOnAllPages("Alaric");
pdf.SaveAs("redacted.pdf");
using IronPdf;
PdfDocument pdf = PdfDocument.FromFile("novel.pdf");
// Redact 'Alaric' phrase from all pages
pdf.RedactTextOnAllPages("Alaric");
pdf.SaveAs("redacted.pdf");
Imports IronPdf
Private pdf As PdfDocument = PdfDocument.FromFile("novel.pdf")
' Redact 'Alaric' phrase from all pages
pdf.RedactTextOnAllPages("Alaric")
pdf.SaveAs("redacted.pdf")
using Merge 方法在 C# 中合并两个 PDF 文件。 对所有 PdfDocument(无论是新建还是导入的)使用 ReplaceTextOnAllPages,以用新文本替换旧文本。
using IronPdf;
ChromePdfRenderer renderer = new ChromePdfRenderer();
PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>.NET6</h1>");
string oldText = ".NET6";
string newText = ".NET7";
// Replace text on all pages
pdf.ReplaceTextOnAllPages(oldText, newText);
pdf.SaveAs("replaceText.pdf");
using IronPdf;
ChromePdfRenderer renderer = new ChromePdfRenderer();
PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>.NET6</h1>");
string oldText = ".NET6";
string newText = ".NET7";
// Replace text on all pages
pdf.ReplaceTextOnAllPages(oldText, newText);
pdf.SaveAs("replaceText.pdf");
Imports IronPdf
Private renderer As New ChromePdfRenderer()
Private pdf As PdfDocument = renderer.RenderHtmlAsPdf("<h1>.NET6</h1>")
Private oldText As String = ".NET6"
Private newText As String = ".NET7"
' Replace text on all pages
pdf.ReplaceTextOnAllPages(oldText, newText)
pdf.SaveAs("replaceText.pdf")
快速故障排除
| 问题 | 解决方案 |
|---|---|
| 缺少 Visual C++ 运行时 | 安装 Visual C++ 再分发包——Chrome 引擎需要 x86 和 x64 两个版本 |
| 未识别许可证 | 请通过 IronPdf.License.IsLicensed 属性。在执行任何 IronPDF 操作前,请确保已应用许可证 |
| 首次渲染缓慢 | 在 IronPdf.Installation.Initialize() 在启动时调用以预初始化渲染引擎 |
| Linux/Docker 依赖项 | 设置 Installation.LinuxAndDockerDependenciesAutoConfig = true 用于自动安装依赖项 |
后续步骤
常见问题解答
我如何设置IronPDFEngine进行远程PDF生成?
要设置IronPDFEngine进行远程PDF生成,请从NuGet安装IronPdf.Slim包,并使用IronPDFConnectionConfiguration类配置连接设置。此设置允许您将应用程序远程连接到IronPDFEngine实例。
使用IronPDFEngine与我的应用程序的主要好处是什么?
在应用程序中使用IronPDFEngine可以远程执行PDF任务,帮助避免平台特定的兼容性问题,特别是在旧系统和移动平台上。此外,它在执行期间不需要.NET运行时。
为什么我可能选择使用IronPDFEngine而不是本地PDF库?
您可能选择使用IronPDFEngine来远程运行性能密集型的PDF功能,减少与不同操作系统的兼容性问题,并通过利用与Chrome相同的渲染器提高HTML到PDF转换的性能。
IronPDFEngine支持水平扩展吗?
不,IronPDFEngine目前不支持水平扩展,这意味着由于服务器内存中PDF文件二进制文件的处理方式,它无法负载均衡到多个实例。
IronPDFEngine可以在不同操作系统上运行吗?
IronPDFEngine设计用于使用Docker容器在Linux系统上运行。然而,二进制文件是平台特定的,因此您需要确保使用适合您操作系统的版本。
如果使用IronPDFEngine时我的PDF输出不同,我该怎么办?
由于不同操作系统的行为,PDF输出可能会略有不同。为了减少差异,请确保您使用正确的Docker镜像,并检查可能影响渲染的任何操作系统特定设置。
我如何确保我的应用程序使用正确版本的IronPDFEngine?
为了确保兼容性,每个版本的IronPDF都需要匹配版本的IronPDFEngine。请确保同时更新两个组件,以避免跨版本问题。
在Windows上使用IronPDFEngine有哪些限制?
在Windows上使用IronPDFEngine时,您需要Linux Containers for Docker,并必须确保服务器端口可访问。二进制文件是平台特定的,需要切换到Linux Containers。
如何配置IronPDF以连接到远程IronPDFEngine服务器?
要为远程服务器配置IronPDF,请使用Installation.ConnectToIronPDFHost方法中的IronPdf.GrpcLayer.IronPDFConnectionConfiguration.RemoteServer,指定服务器的IP和端口详细信息。
使用IronPDFEngine时应该使用哪个包以最小化应用程序大小?
您应使用NuGet中的IronPdf.Slim包,因为它仅包含运行IronPDF与IronPDFEngine所需的组件,从而减少应用程序大小。

