首页
/ Scryber.Core 使用教程

Scryber.Core 使用教程

2025-04-20 11:52:53作者:柏廷章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 文档。

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

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

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
179
263
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
869
514
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
130
183
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
295
331
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
333
1.09 K
harmony-utilsharmony-utils
harmony-utils 一款功能丰富且极易上手的HarmonyOS工具库,借助众多实用工具类,致力于助力开发者迅速构建鸿蒙应用。其封装的工具涵盖了APP、设备、屏幕、授权、通知、线程间通信、弹框、吐司、生物认证、用户首选项、拍照、相册、扫码、文件、日志,异常捕获、字符、字符串、数字、集合、日期、随机、base64、加密、解密、JSON等一系列的功能和操作,能够满足各种不同的开发需求。
ArkTS
18
0
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.08 K
0
kernelkernel
deepin linux kernel
C
22
5
WxJavaWxJava
微信开发 Java SDK,支持微信支付、开放平台、公众号、视频号、企业微信、小程序等的后端开发,记得关注公众号及时接受版本更新信息,以及加入微信群进行深入讨论
Java
829
22
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
601
58