Scryber.Core 使用教程

2025-04-20 05:12:19作者：柏廷章Berta

1. 项目介绍

Scryber.Core 是一个基于 .NET 6 开发的 HTML 到 PDF 转换引擎，完全使用 C# 编写。它支持从 HTML 模板创建美观的流动文档，包括 CSS 样式、对象数据绑定和 SVG 绘图。Scryber.Core 提供了灵活的布局和页面设计，适用于创建具有标准 HTML 元素和新型 HTML5 标签的文档。该库同时支持数据绑定、外部内容嵌入、多种字体和图形绘制等功能，是创建 PDF 文档的强大工具。

2. 项目快速启动

环境准备

确保您的开发环境已安装 .NET 6 SDK。

创建项目

使用 NuGet 包管理器安装 Scryber.Core：

Install-Package Scryber.Core

或者如果您使用的是 ASP.NET MVC，可以安装：

Install-Package Scryber.Core.Mvc

示例代码

以下是一个简单的示例，展示如何从 HTML 模板生成 PDF 文档：

using Scryber.Components;

class Program
{
    static void Main(string[] args)
    {
        // 加载 HTML 模板
        string path = "path/to/your/template.html";

        // 创建模型数据
        var model = new {
            titlestyle = "color:#ff6347",
            title = "Hello from scryber",
            items = new[] {
                new { name = "First item" },
                new { name = "Second item" },
                new { name = "Third item" }
            }
        };

        using (var doc = Document.ParseDocument(path))
        {
            // 设置参数
            doc.Params["author"] = "Scryber Engine";
            doc.Params["--head-bg"] = "#333";
            doc.Params["--head-txt"] = "#FFF";
            doc.Params["model"] = model;

            // 生成 PDF 并保存到文件
            using (var stream = new FileStream("output.pdf", FileMode.Create))
            {
                doc.SaveAsPDF(stream);
            }
        }
    }
}

确保替换 path/to/your/template.html 为您的 HTML 模板文件路径。

3. 应用案例和最佳实践

HTML 模板编写

创建一个 HTML 文件作为文档模板，可以使用 HTML 和 CSS 定义页面布局和样式。例如：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Document</title>
    <style>
        body { font-family: sans-serif; }
        .header { background-color: #333; color: #fff; padding: 10px; }
    </style>
</head>
<body>
    <div class="header">Document Header</div>
    <div>Document Body Content</div>
    <div class="footer">Document Footer</div>
</body>
</html>

数据绑定

在模板中使用数据绑定来动态填充内容：

<template data-bind="{{model.items}}">
    <div>{{.name}}</div>
</template>

在代码中传递模型数据：

doc.Params["model"] = new { items = new[] { new { name = "Item 1" }, new { name = "Item 2" } } };

4. 典型生态项目

Scryber.Core 可以与多种 .NET 生态系统中的项目集成，例如：

ASP.NET Core MVC：在 MVC 应用程序中生成 PDF 响应。
.NET Core Console Apps：创建后台任务生成 PDF 文件。
Blazor：在 WebAssembly 应用程序中生成 PDF 文档。

每个项目类型都有其特定的使用方式和集成点，可以根据具体需求进行选择和集成。

登录后查看全文

Scryber.Core 使用教程

1. 项目介绍

2. 项目快速启动

环境准备

创建项目

示例代码

3. 应用案例和最佳实践

HTML 模板编写

数据绑定

4. 典型生态项目

最新内容推荐

项目优选

Scryber.Core 使用教程

1. 项目介绍

2. 项目快速启动

环境准备

创建项目

示例代码

3. 应用案例和最佳实践

HTML 模板编写

数据绑定

4. 典型生态项目

相关内容推荐

最新内容推荐

项目优选