Rotativa 技术文档

1. 安装指南

Rotativa 是一个用于在 Asp.net MVC 中轻松创建 PDF 文件的库。以下是安装步骤：

• 首先，您需要在项目中引入 Rotativa。可以通过 NuGet 包管理器完成此操作。在 NuGet 包管理器控制台中执行以下命令：

  Install-Package Rotativa
  

• 确保您的项目中已安装了 wkhtmltopdf。这是一个命令行工具，用于将 HTML 转换为 PDF。您可以从 wkhtmltopdf 官网 下载并安装。

• 将 wkhtmltopdf 的可执行文件放置在项目的某个文件夹中，例如 "Rotativa"。如果放置在其他位置，请在配置中指定正确的路径。

2. 项目使用说明

Rotativa 提供了多种方式来生成 PDF 文件。以下是一些基本用法：

ActionAsPdf

此方法允许您从 MVC 的 Action 方法直接生成 PDF。

public ActionResult PrintIndex()
{
    return new ActionAsPdf("Index", new { name = "Giorgio" }) { FileName = "Test.pdf" };
}

ViewAsPdf

此方法允许您将视图直接转换为 PDF。

public ActionResult TestViewWithModel(string id)
{
    var model = new TestViewModel { DocTitle = id, DocContent = "This is a test" };
    return new ViewAsPdf(model);
}

此外，Rotativa 还提供了 RouteAsPdf、UrlAsPdf 和 ViewAsPdf ActionResult。

Rotativa 支持从经过授权的 Action（如使用 Web Forms 身份验证）生成 PDF。

您还可以使用 ActionAsImage、ViewAsImage、RouteAsImage 和 UrlAsImage 输出图像。

3. 项目 API 使用文档

以下是 Rotativa 的一些主要 API：

• ActionAsPdf: 从 Action 方法生成 PDF。
• ViewAsPdf: 将视图转换为 PDF。
• RouteAsPdf: 从路由生成 PDF。
• UrlAsPdf: 从 URL 生成 PDF。
• ActionAsImage: 从 Action 方法生成图像。
• ViewAsImage: 从视图生成图像。
• RouteAsImage: 从路由生成图像。
• UrlAsImage: 从 URL 生成图像。

4. 项目安装方式

如前所述，您可以通过 NuGet 包管理器安装 Rotativa。在 NuGet 包管理器控制台中运行以下命令：

Install-Package Rotativa

然后，确保已安装 wkhtmltopdf 并将其可执行文件放置在项目中的合适位置。如果需要，您可以在配置中指定 wkhtmltopdf 的路径。