使用Spire.Doc组件利用模板导出Word文档

citgpt 2024-10-26 08:39 21 浏览 0 评论

以前一直是用Office的组件实现Word文档导出，但是让客户在服务器安装Office，涉及到版权；而且Office安装，包括权限配置也是比较麻烦。

现在流行使用第三方组件来实现对Office的操作，有NPOI，Spire等第三方组件。开始考虑的是NPOI，毕竟它在操作Excel方面还是很强大的；但是不知道是它本身没有，还是我没找到，无法实现利用Word模板的标签插入内容，纯靠代码去生成Word文档，排版是个大问题。最终找到了Spire.Doc组件，轻松实现！

　　Spire的官网地址：https://www.e-iceblue.com/

1、项目中引用 Free Spire.Doc 组件，我是直接用NuGet下载包的.

安装完后，会引用其三个组件：

2、Word 模板制作

打开Word，点击文件->选项->自定义功能区，勾选上“开发工具”：

主要使用文本域控件，插入作为标签：

如果有需要，可以添加“下划线”，或者“字符边框”等效果：

底下三个，前2个我用的是开发工具中的复选框（窗体控件）效果不是勾选的，是×号，效果不是客户想要的，所以使用了第二种解决方案“字符边框”，最后看导出的效果：

3、代码

可重用代码：

using Spire.Doc;
using Spire.Doc.Documents;
using Spire.Doc.Fields;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace We.Framework.Spire
{
    /// <summary>
    /// Sprie.Doc
    /// Designed by XIAO
    /// 2017-05-09
    /// </summary>
    public class WordHandler
    {
        public static bool ExportWordByFields<T>(T mod, string TempleteFilePath, string ExpFilePath)
        {
            if (mod == null)
            {
                throw new Exception("模型为空！");
            }

            System.Reflection.PropertyInfo[] properties = mod.GetType().GetProperties(System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.Public);
            if (properties.Length <= 0)
            {
                throw new Exception("模型属性为空！");
            }

            if (!File.Exists(TempleteFilePath))
            {
                throw new Exception("指定路径的模板文件不存在！");
            }

            try
            {
                Document doc = new Document();
                doc.LoadFromFile(TempleteFilePath);

                #region 替换文字
                //doc.Replace("海关", "海关口岸", true, true);
                //doc.Replace("报验", "报检", true, true);
                #endregion

                //清除表单域阴影
                doc.Properties.FormFieldShading = false;

                //遍历Word模板中的文本域（field.name为文本域名称）
                foreach (FormField field in doc.Sections[0].Body.FormFields)
                {
                    foreach (System.Reflection.PropertyInfo prop in properties)
                    {
                        string name = prop.Name; //属性名称
                        object value = prop.GetValue(mod, null);  //属性值
                        string des = ((DescriptionAttribute)Attribute.GetCustomAttribute(prop, typeof(DescriptionAttribute))).Description;// 属性描述值

                        //注意：文本域名称 == 模型中属性的 Description 值 ！！！！！！
                        //也可以： 文本域名称 == 模型中属性的 Name 值 ！！！！！！
                        if (field.Name == des)
                        {
                            if (field.DocumentObjectType == DocumentObjectType.TextFormField)   //文本域
                            {
                                if (prop.PropertyType.Name == "Boolean")
                                {
                                    field.Text = "√";   //插入勾选符号
                                    break;
                                }
                                else
                                {
                                    field.Text = value.ToString();   //向Word模板中插入值
                                    break;
                                }
                            }
                            else if (field.DocumentObjectType == DocumentObjectType.CheckBox)   //复选框
                            {
                                (field as CheckBoxFormField).Checked = (value as bool?).HasValue ? (value as bool?).Value : false;
                            }
                        }
                    }
                }

                doc.SaveToFile(ExpFilePath, FileFormat.Docx);
                doc.Close();

                return true;
            }
            catch (Exception ex)
            {
                string msg = ex.Message;

                return false;
            }
        }
    }
}

3、代码

可重用代码：

using Spire.Doc;
using Spire.Doc.Documents;
using Spire.Doc.Fields;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace We.Framework.Spire
{
    /// <summary>
    /// Sprie.Doc
    /// Designed by XIAO
    /// 2017-05-09
    /// </summary>
    public class WordHandler
    {
        public static bool ExportWordByFields<T>(T mod, string TempleteFilePath, string ExpFilePath)
        {
            if (mod == null)
            {
                throw new Exception("模型为空！");
            }

            System.Reflection.PropertyInfo[] properties = mod.GetType().GetProperties(System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.Public);
            if (properties.Length <= 0)
            {
                throw new Exception("模型属性为空！");
            }

            if (!File.Exists(TempleteFilePath))
            {
                throw new Exception("指定路径的模板文件不存在！");
            }

            try
            {
                Document doc = new Document();
                doc.LoadFromFile(TempleteFilePath);

                #region 替换文字
                //doc.Replace("海关", "海关口岸", true, true);
                //doc.Replace("报验", "报检", true, true);
                #endregion

                //清除表单域阴影
                doc.Properties.FormFieldShading = false;

                //遍历Word模板中的文本域（field.name为文本域名称）
                foreach (FormField field in doc.Sections[0].Body.FormFields)
                {
                    foreach (System.Reflection.PropertyInfo prop in properties)
                    {
                        string name = prop.Name; //属性名称
                        object value = prop.GetValue(mod, null);  //属性值
                        string des = ((DescriptionAttribute)Attribute.GetCustomAttribute(prop, typeof(DescriptionAttribute))).Description;// 属性描述值

                        //注意：文本域名称 == 模型中属性的 Description 值 ！！！！！！
                        //也可以： 文本域名称 == 模型中属性的 Name 值 ！！！！！！
                        if (field.Name == des)
                        {
                            if (field.DocumentObjectType == DocumentObjectType.TextFormField)   //文本域
                            {
                                if (prop.PropertyType.Name == "Boolean")
                                {
                                    field.Text = "√";   //插入勾选符号
                                    break;
                                }
                                else
                                {
                                    field.Text = value.ToString();   //向Word模板中插入值
                                    break;
                                }
                            }
                            else if (field.DocumentObjectType == DocumentObjectType.CheckBox)   //复选框
                            {
                                (field as CheckBoxFormField).Checked = (value as bool?).HasValue ? (value as bool?).Value : false;
                            }
                        }
                    }
                }

                doc.SaveToFile(ExpFilePath, FileFormat.Docx);
                doc.Close();

                return true;
            }
            catch (Exception ex)
            {
                string msg = ex.Message;

                return false;
            }
        }
    }
}

基本功能已经实现，还有待改进，希望各位提出宝贵意见！

（PS：如果有朋友知道NPOI如何实现类似功能的，望告知下！先谢谢了！^_^）