首页
/ Scryber.Core 使用教程

Scryber.Core 使用教程

2025-04-20 09:26:18作者:柏廷章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 文档。

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

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
152
1.96 K
kernelkernel
deepin linux kernel
C
22
6
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
431
34
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
251
9
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
989
394
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
193
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
936
554
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
75
69