ASP.NET 開源導入導出庫Magicodes.IE 導出Pdf教程

来源:https://www.cnblogs.com/yyfh/archive/2020/01/21/12222388.html
-Advertisement-
Play Games

基礎教程之導出Pdf收據 說明 本教程主要說明如何使用Magicodes.IE.Pdf完成Pdf收據導出 要點 導出PDF數據 自定義PDF模板 導出單據 如何批量導出單據 導出特性 PdfExporterAttribute + Orientation ： 方向(橫向或縱向) + PaperKind ...


基礎教程之導出Pdf收據

說明

本教程主要說明如何使用Magicodes.IE.Pdf完成Pdf收據導出

要點

  • 導出PDF數據
  • 自定義PDF模板
  • 導出單據
  • 如何批量導出單據

導出特性

PdfExporterAttribute

  • Orientation： 方向(橫向或縱向)
  • PaperKind： 紙張類型（預設A4）
  • IsWriteHtml： 是否輸出HTML模板

ExporterHeaderAttribute

DisplayName： 顯示名稱

主要步驟

1.安裝包Magicodes.IE.Pdf

Install-Package Magicodes.IE.Pdf

2.導出PDF數據

  • 創建Dto類
        public class Student
        {
            /// <summary>
            ///     姓名
            /// </summary>
            public string Name { get; set; }
            /// <summary>
            ///     年齡
            /// </summary>
            public int Age { get; set; }
        }
       public async Task ExportPdf()
        {
            var exporter = new PdfExporter();
            var result = await exporter.ExportListByTemplate("test.pdf", new List<Student>()
            {
                new Student
                {
                    Name = "MR.A",
                    Age = 18
                },
                new Student
                {
                    Name = "MR.B",
                    Age = 19
                },
                new Student
                {
                    Name = "MR.B",
                    Age = 20
                }
            });
        }

導出內容如下所示：

通過上述代碼我們實現了一個簡單的Pdf文件導出，也許這樣無法達到我們的要求，我們需要自定義標題，那麼請看如下代碼

        [PdfExporter(Name = "學生信息")]
        public class Student
        {
            /// <summary>
            ///     姓名
            /// </summary>
            [ExporterHeader(DisplayName = "姓名")]
            [Display(Name = "Display姓名")]
            public string Name { get; set; }
            /// <summary>
            ///     年齡
            /// </summary>
            [ExporterHeader(DisplayName = "年齡")]
            public int Age { get; set; }
        }
  1. PdfExporter 通過Name屬性來定義文檔標題
  2. ExporterHeader DisplayName用來定義屬性名稱
  3. Display同樣定義屬性名稱，但是優先順序小於ExporterHeader

通過修改上述代碼執行結果如下所示：

3.導出PDF收據

  • 創建導出模板
@using DocumentFormat.OpenXml.EMMA
<!DOCTYPE html>

<html lang="en" xmlns="http://www.w3.org/1999/xhtml">

<head>
    <meta charset="utf-8"/>
    <title></title>
    <style type="text/css">
        body { font-family: SimSun !important; }

        p { margin: 0px; }

        footer {
            color: #333;
            font-size: 1.2rem;
            margin-bottom: 1.5rem;
            margin-right: 5%;
            margin-top: 1.2rem;
            text-align: right;
        }

        table,
        td {
            border: 1px solid #444;
            border-collapse: collapse;
            /* text-align: center; */
            height: 2rem;
            padding: 5px;
        }
    </style>
</head>

<body>
<p style="color: #000; font-size: 1.8rem; height: 32px; text-align: center;">
    @Model.Title
</p>
<p style="color: #333; font-size: 1.2rem; margin-left: 5%; margin-top: 1%;">
    <text>NO：@Model.Data.Code</text>
    <text style="padding-left: 52%; text-align: right;">交易時間：@Model.Data.TradeTime.ToString("yyyy-MM-dd HH:mm:ss")</text>
</p>

<table width="90%" style="margin-left: 5%; margin-top: 1%;">
    <tr style="font-size: 1rem;">
        <td style="text-align: center; width: 11%;">交款姓名</td>
        <td colspan="2">@Model.Data.Name</td>
        <td style="text-align: center; width: 13%;">身份證號碼</td>
        <td colspan="3">@Model.Data.IdNo</td>
    </tr>
    <tr style="font-size: 1rem;">
        <td style="text-align: center">交易金額</td>
        <td colspan="6">
            <span>￥：@Model.Data.Amount</span>
            <span style="padding: 0 2% 0 2%;">人民幣(大寫):</span>
            <span>@Model.Data.UppercaseAmount</span>
        </td>
    </tr>
    <tr style="font-size: 1rem;">
        <td style="text-align: center">收款方式</td>
        <td colspan="2">@Model.Data.PaymentMethod</td>
        <td style="text-align: center; width: 13%;">交易狀態</td>
        <td colspan="3">@Model.Data.TradeStatus</td>
    </tr>

    <tr style="font-size: 1rem;">
        <td style="text-align: center">收款事由</td>
        <td style="width: 22.3%;">@Model.Data.Remark</td>
        <td style="text-align: center; width: 11%;">入學年級</td>
        <td style="width: 22.3%;" colspan="2">@Model.Data.Grade</td>
        <td style="text-align: center; width: 11%;">專業</td>
        <td style="width: 22.3%;">@Model.Data.Profession</td>
    </tr>


</table>
</body>
</html>

  • 創建Dto類

        [Exporter(Name = "湖南心萊信息科技有限公司電子收款憑證")]
    public class ReceiptInfo
    {
        /// <summary>
        ///     交易時間
        /// </summary>
        public DateTime TradeTime { get; set; }

        /// <summary>
        ///     姓名
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        ///     身份證
        /// </summary>
        public string IdNo { get; set; }

        /// <summary>
        ///     金額
        /// </summary>
        public decimal Amount { get; set; }

        /// <summary>
        ///     支付方式
        /// </summary>
        public string PaymentMethod { get; set; }

        /// <summary>
        ///     交易狀態
        /// </summary>
        public string TradeStatus { get; set; }

        /// <summary>
        ///     備註
        /// </summary>
        public string Remark { get; set; }

        /// <summary>
        ///     年級
        /// </summary>
        public string Grade { get; set; }

        /// <summary>
        ///     專業
        /// </summary>
        public string Profession { get; set; }

        /// <summary>
        ///     收款人
        /// </summary>
        public string Payee { get; set; }

        /// <summary>
        ///     大寫金額
        /// </summary>
        public string UppercaseAmount { get; set; }

        /// <summary>
        ///     編號
        /// </summary>
        public string Code { get; set; }
    }
    1. 如上代碼片段通過Exporter 特性去指定模板中的Title，當然在我們實際開發中也可以不通過該屬性去做指定，畢竟我們這一塊也是完全自定義的

  • 怎麼使用？

            public async Task ExportReceipt()
        {
            var tplPath = Path.Combine(Directory.GetCurrentDirectory(), "TestFiles", "ExportTemplates",
                "receipt.cshtml");
            var tpl = File.ReadAllText(tplPath);
            var exporter = new PdfExporter();
            //此處使用預設模板導出
            var result = await exporter.ExportByTemplate("test.pdf",
                new ReceiptInfo
                {
                    Amount = 22939.43M,
                    Grade = "2019秋",
                    IdNo = "43062619890622xxxx",
                    Name = "張三",
                    Payee = "湖南心萊信息科技有限公司",
                    PaymentMethod = "微信支付",
                    Profession = "運動訓練",
                    Remark = "學費",
                    TradeStatus = "已完成",
                    TradeTime = DateTime.Now,
                    UppercaseAmount = "貳萬貳仟玖佰叄拾玖圓肆角叄分",
                    Code = "19071800001"
                }, tpl);
        }

    通過上述代碼我們需要進行指定傳遞我們模板路徑及模板內容，最終導出效果如下：

4.批量導出PDF收據

  • 創建模板

    <!DOCTYPE html>

<html lang="en" xmlns="http://www.w3.org/1999/xhtml">

<head>
    <meta charset="utf-8"/>
    <title></title>
    <style type="text/css">
        body { font-family: SimSun !important; }

        p { margin: 0px; }

        footer {
            color: #333;
            font-size: 1.2rem;
            margin-bottom: 1.5rem;
            margin-right: 5%;
            margin-top: 1.2rem;
            text-align: right;
        }

        table,
        td {
            border: 1px solid #444;
            border-collapse: collapse;
            height: 2rem;
            padding: 5px;
        }

        .evenNum {
            margin-bottom: 8%;
            padding-top: 10%;
        }
    </style>
</head>

<body>
@for (var i = 0; i < Model.Data.ReceiptInfoInputs.Count; i++)
{
    <div style="height: 41%; width: 100%;" class="@(i % 2 == 0 ? "" : "evenNum")">
        <p style="color: #000; font-size: 1.8rem; height: 32px; text-align: center;">
            @Model.Data.Title
        </p>
        <p style="color: #333; font-size: 1.2rem; margin-left: 5%; margin-top: 1%;">
            <text>NO：@Model.Data.ReceiptInfoInputs[i].Code</text>
            <text style="padding-left: 52%; text-align: right;">交易時間：@Model.Data.ReceiptInfoInputs[i].TradeTime.ToString("yyyy-MM-dd HH:mm:ss")</text>
        </p>

        <table width="90%" style="margin-left: 5%; margin-top: 1%;">
            <tr style="font-size: 1rem;">
                <td style="text-align: center; width: 11%;">交款姓名</td>
                <td colspan="2">@Model.Data.ReceiptInfoInputs[i].Name</td>
                <td style="text-align: center; width: 13%;">身份證號碼</td>
                <td colspan="3">@Model.Data.ReceiptInfoInputs[i].IdNo</td>
            </tr>
            <tr style="font-size: 1rem;">
                <td style="text-align: center">交易金額</td>
                <td colspan="6">
                    <span>￥：@Model.Data.ReceiptInfoInputs[i].Amount</span>
                    <span style="padding: 0 2% 0 2%;">人民幣(大寫):</span>
                    <span>@Model.Data.ReceiptInfoInputs[i].UppercaseAmount</span>
                </td>
            </tr>
            <tr style="font-size: 1rem;">
                <td style="text-align: center">收款方式</td>
                <td colspan="2">@Model.Data.ReceiptInfoInputs[i].PaymentMethod</td>
                <td style="text-align: center; width: 13%;">交易狀態</td>
                <td colspan="3">@Model.Data.ReceiptInfoInputs[i].TradeStatus</td>
            </tr>

            <tr style="font-size: 1rem;">
                <td style="text-align: center">收款事由</td>
                <td style="width: 22.3%;">@Model.Data.ReceiptInfoInputs[i].Remark</td>
                <td style="text-align: center; width: 11%;">入學年級</td>
                <td style="width: 22.3%;" colspan="2">@Model.Data.ReceiptInfoInputs[i].Grade</td>
                <td style="text-align: center; width: 11%;">專業</td>
                <td style="width: 22.3%;">@Model.Data.ReceiptInfoInputs[i].Profession</td>
            </tr>


        </table>
    </div>
}
</body>
</html>

  • 創建Dto類

        /// <summary>
    ///     批量導出Dto
    /// </summary>
    [PdfExporter(Orientation = Orientation.Portrait, PaperKind = PaperKind.A5)]
    public class BatchReceiptInfoDto
    {
        /// <summary>
        ///     交易時間
        /// </summary>
        public DateTime TradeTime { get; set; }

        /// <summary>
        ///     姓名
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        ///     身份證
        /// </summary>
        public string IdNo { get; set; }

        /// <summary>
        ///     金額
        /// </summary>
        public decimal Amount { get; set; }

        /// <summary>
        ///     支付方式
        /// </summary>
        public string PaymentMethod { get; set; }

        /// <summary>
        ///     交易狀態
        /// </summary>
        public string TradeStatus { get; set; }

        /// <summary>
        ///     備註
        /// </summary>
        public string Remark { get; set; }

        /// <summary>
        ///     年級
        /// </summary>
        public string Grade { get; set; }

        /// <summary>
        ///     專業
        /// </summary>
        public string Profession { get; set; }

        /// <summary>
        ///     大寫金額
        /// </summary>
        public string UppercaseAmount { get; set; }

        /// <summary>
        ///     編號
        /// </summary>
        public string Code { get; set; }
    }

  • 如何使用

            public async Task BathExportReceipt()
        {
            var tplPath = Path.Combine(Directory.GetCurrentDirectory(), "TestFiles", "ExportTemplates",
                "batchReceipt.cshtml");
            var tpl = File.ReadAllText(tplPath);
            var exporter = new PdfExporter();

            var input = new BatchReceiptInfoInput
            {
                Payee = "湖南心萊信息科技有限公司",
                ReceiptInfoInputs = new List<BatchReceiptInfoDto>()
            };

            for (var i = 0; i < 20; i++)
                input.ReceiptInfoInputs.Add(new BatchReceiptInfoDto
                {
                    Amount = 22939.43M,
                    Grade = "2019秋",
                    IdNo = "43062619890622xxxx",
                    Name = "張三",
                    PaymentMethod = "微信支付",
                    Profession = "運動訓練",
                    Remark = "學費",
                    TradeStatus = "已完成",
                    TradeTime = DateTime.Now,
                    UppercaseAmount = "貳萬貳仟玖佰叄拾玖圓肆角叄分",
                    Code = "1907180000" + i
                });

            //此處使用預設模板導出
            var result = await exporter.ExportByTemplate("test.pdf", input, tpl);
        }

通過上述代碼我們需要進行指定傳遞我們模板路徑及模板內容，最終導出效果如下：

  1. PdfExporterAttribute Orientation進行方向如橫向或縱向
  2. PaperKind 紙張類型（預設A4）

Reference

https://github.com/dotnetcore/Magicodes.IE


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • IDEA中編輯HTML格式，不自動縮進問題
    在IntelliJ Idea中HTML格式化時，預設head和body標簽以及body下的標簽都不會縮進，這就導致你每次寫好html時候格式化的時候所有標簽都是同一層級沒有縮進，一般我們寫html都會層級關係標簽嵌套，通過縮進看代碼結構就很清晰明朗 ...
  • ZXing生成二維碼
    1.什麼是二維碼？ ​ （百度百科）：二維碼又稱二維條碼，常見的二維碼為QR Code，QR全稱Quick Response，是一個近幾年來移動設備上超流行的一種編碼方式，它比傳統的Bar Code條形碼能存更多的信息，也能表示更多的數據類型。 2.利用ZXING生成二維碼 ​ ·對應POM <de ...
  • 本地緩存google.guava及分散式緩存redis 隨筆
    近期項目用到了緩存,我選用的是主流的google.guava作本地緩存,redis作分散式 緩存,先說說我對本地緩存和分散式緩存的理解吧,可能不太成熟的地方,大家指出,一起 學習.本地緩存的特點是速度快,不會受到網路阻塞的干擾,但由於是放在本地記憶體中,所 以容量較小,不能項目間共用比IO效率高比re ...
  • php非同步處理
    a.php <?phpheader("Content-type: text/html; charset=utf-8");date_default_timezone_set("Asia/Shanghai"); $start = microtime(true); function fsockopen_g ...
  • spring aop使用，spring aop註解，Spring切麵編程
    ©Copyright 蕃薯耀 2020-01-21 https://www.cnblogs.com/fanshuyao/ 一、第一步，引用依賴類，在Pom.xml加入依賴 <dependencies> <dependency> <groupId>org.springframework</groupI ...
  • 「掃盲」Elasticsearch
    前言 只有光頭才能變強。 文本已收錄至我的GitHub精選文章，歡迎Star ： "https://github.com/ZhongFuCheng3y/3y" 不知道大家的公司用Elasticsearch多不多，反正我公司的是有在用的。平時聽同事們聊天肯定避免不了不認識的技術棧，例如說：把數據放在引 ...
  • .NET CORE(C#) WPF 重新設計Instagram
    微信公眾號： "Dotnet9" ，網站： "Dotnet9" ，問題或建議： "請網站留言" ， 如果對您有所幫助： "歡迎贊賞" 。 .NET CORE(C ) WPF 重新設計Instagram 閱讀導航 1. 本文背景 2. 代碼實現 3. 本文參考 4. 源碼 1. 本文背景 老外的一個界 ...
  • Serilog高級玩法之用Serilog記錄所選終結點附加屬性
    這是該系列的第二篇文章： "在ASP.NET Core 3.0中使用Serilog.AspNetCore" 。 1. "第1部分 使用Serilog RequestLogging來簡化ASP.NET Core的日誌輸出" 2. "第2部分 用Serilog記錄所選終結點的附加屬性" （本文） 3. ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類