用户自定义模板中数据标签

• 查看本示例演示效果
• 实际应用演示效果

注意

本文中展示的代码均为关键代码，复制粘贴到您的项目中，按照实际的情况，例如文档路径，用户名等做适当修改即可使用。

笔记

数据标签（DataTag）只是一种辨识度比较高的文本字符串，样式完全由开发人员自己说了算。比如这样的数据标签“【##日期$$】”，编写代码openDataTag("【##日期$$】")即可返回数据标签对象，进而可以对此数据标签填充数据或设置样式等操作。

在实际的Word文档开发中，经常需要自动填充数据到Word模板中，以生成动态的Word文档，那么应该如何使用PageOffice概念中的数据标签（DataTag）编辑制作Word模板呢？

方法一：直接打开Word文件插入数据标签

假如使用数据标签（DataTag）来定义模板中动态填充数据的位置，那么直接打开一个Word文件，在其中添加自定义特殊格式的文本即可制作word模板。例如，打开一个Word文件后，可以直接插入“{部门名}”、“{姓名}”、“【时间】”等类似的、辨识度很高的、特殊格式的文本。效果如下图所示：

Word模板中需要多少个动态填充数据的位置，就在Word文件中相应的位置插入多少数据标签即可。这种制作word模板的方法操作简单，但是常用于开发新项目时定义Word模板，开发人员知道在Word模板的哪个位置需要插入哪个数据，把所有需要动态填充数据的数据标签插入到Word中，就可以编程调用PageOffice接口给这些数据标签填充数据，就比如操作上面的“【时间】”，代码这样写openDataTag("【时间】").setvalue("当前时间")，就可以把当前时间赋值给数据标签。其他的数据标签也是相同的处理方式，但是项目发布后，如果用户的需求发生变动，希望修改Word模板或创建新的Word模板，用户怎么知道如何制作word模板呢？如何插入和命名数据标签？哪些数据标签与哪些系统数据是对应的呢？

方法二：给用户提供自定义模板功能

开发人员可以给系统增加一个模板管理的模块，拥有模板管理权限的用户可以查看系统中的模板列表，可以新增、删除和在线编辑模板，开发人员通过程序定义好编辑某种模板时可能用到的所有数据标签，用户自定义编辑Word模板时可以把全部数据标签插入到模板的相应位置，也可以根据实际需求只使用部分数据标签，但Word模板中用到的数据标签总是开发人员定义的数据标签集合的子集，这样一来就能实现开发人员与用户的分工合作。

比如说web系统中合同模板的制作，合同模板中可能会用到的数据有：甲方、乙方、担保人、合同编号、合同日期，那么开发人员可以编写代码定义好这些数据标签，让用户在线打开编辑模板时，只能在Word模板中插入这些系统定义好的数据标签，这样做不但实现了开发人员与用户的一种约定，而且规范了用户的操作。

1. 开发人员编写代码定义好编辑模板时所有可用的数据标签：

开发人员调用PageOffice提供的defineDataTag方法定义用户编辑模板时所有可用的数据标签。数据标签的格式没有特殊要求，下面示例代码中分别使用了英文中括号和中文中括号（也可以使用其他符号），是为了便于用户直观的查看Word模板中哪些位置是插入的数据标签，也是为了通过程序给数据标签动态赋值的时候与普通的正文内容做区别处理。

WordDocumentWriter doc = new WordDocumentWriter();
doc.getTemplate().defineDataTag("{ 甲方 }");
doc.getTemplate().defineDataTag("{ 乙方 }");
doc.getTemplate().defineDataTag("{ 担保人 }");
doc.getTemplate().defineDataTag("【 合同日期 】");
doc.getTemplate().defineDataTag("【 合同编号 】");

PageOfficeNetCore.Word.WordDocumentWriter doc = new PageOfficeNetCore.Word.WordDocumentWriter();
doc.Template.DefineDataTag("{ 甲方 }");
doc.Template.DefineDataTag("{ 乙方 }");
doc.Template.DefineDataTag("{ 担保人 }");
doc.Template.DefineDataTag("【 合同日期 】");
doc.Template.DefineDataTag("【 合同编号 】");

// Make sure to add code blocks to your code group

2. 用户编辑模板时，直接使用开发人员定义好的数据标签来制作模板：

开发人员可以根据实际需求，在自己的Web项目中实现下面的编辑模板效果。

把数据标签列表和Word文件编辑界面，一左一右放到同一个页面窗口中，用户在右侧Word文件中点击定位光标到需要插入数据的位置，然后在左侧选择相应的数据标签，添加到当前位置即可。比如下图所示：在Word中需要插入“乙方”的位置点击一下鼠标，然后在左侧“待添加标签”中点击数据标签“{ 乙方 }”的添加按钮，“{ 乙方 }”标签就被插入到了Word光标所在位置。

此效果所用到的html、css和javascript代码：

    <style>
        body {
            margin: 0;
            padding: 0;
            display: flex;
        }
		div{
			 box-sizing: border-box; 
		}
        #left-container {
            width: 360px;
            display: flex;
            flex-direction: column;
            border-right: 2px solid #ccc;
            padding: 20px;
            overflow: auto;
            font-size: 12px;
            height: 90vh;
        }
        #right-container {
            flex: 1;
            padding: 0px;
            height: 95vh;
        }
        #podiv{
            width: 100%;
            height: 100%;
            margin: 0;
            padding: 0;
        }
        #left-title{
            text-align: center;
            font-size: 16px;
            padding-bottom: 10px;
            margin-bottom: 10px;
            border-bottom: solid 1px #ccc;
        }

        .input-group {
            margin-bottom: 20px;
            display: flex;
            align-items: center;
        }
        input[type="text"] {
            width: 70%;
            padding: 10px;
            margin-top: 5px;
            box-sizing: border-box;
            border: 1px solid #ccc;
            border-radius: 5px;
            font-size: 12px;
            outline: none;
        }

        input[type="submit"] {
            width: 80px;
            padding: 10px;
            margin-top: 5px;
            margin-left: 10px;
            box-sizing: border-box;
            border: none;
            border-radius: 5px;
            background-color: #4E6EF2;
            color: white;
            font-size: 12px;
            outline: none;
            cursor: pointer;
        }
        /* 表格样式 */
        table {
            border-collapse: collapse;
            width: 100%;
        }

        th, td {
            padding: 8px;
            text-align: left;
            border-bottom: 1px solid #ddd;
        }

        th {
            position: sticky;
            top: 0;
            background-color: #f2f2f2;
            z-index: 1;
        }

        /* 容器样式 */
        .container {
            height: 600px;
            overflow: auto;
            border: solid 1px #ccc;
            scrollbar-width: thin;
            scrollbar-color: #888 #f2f2f2;
        }

        /* 滚动条样式 */
        .container::-webkit-scrollbar {
            width: 8px;
        }

        .container::-webkit-scrollbar-track {
            background: #f2f2f2;
        }

        .container::-webkit-scrollbar-thumb {
            background-color: #888;
            border-radius: 4px;
        }

        .container::-webkit-scrollbar-thumb:hover {
            background-color: #555;
        }
        .delete-button {
            padding: 6px 6px;
            border: none;
            border-radius: 5px;
            background-color: #f44336;
            color: white;
            font-size: 12px;
            cursor: pointer;
        }
        .delete-button:hover {
            background-color: #d32f2f;
        }

        .normal-button {
            padding: 6px 6px;
            border: none;
            border-radius: 5px;
            background-color: #4E7EFF;
            color: white;
            font-size: 12px;
            cursor: pointer;
        }
        .normal-button:hover {
            background-color: #4E6EF2;
        }

        .locate-button {
            padding: 6px 6px;
            border: none;
            border-radius: 5px;
            background-color: #0abb87;
            color: white;
            font-size: 12px;
            cursor: pointer;
        }
        .locate-button:hover {
            background-color: #0a9966;
        }
    </style>
    <script>
        var definedDataTagJson = '';
        var isFromStart = false;
        var lastOpTag = '';

        function OnPageOfficeCtrlInit() {
            pageofficectrl.AddCustomToolButton("保存", "Save", 1);
        }
        function Save() {
            pageofficectrl.WebSave();
        }

        //加载数据
        function loadData() {
            var kWord = document.getElementById("inputKey").value;
            searchDataTag(definedDataTagJson, kWord);
            return;
        }

        //加载上方数据列表
        function searchDataTag(dtDefinedJson, s){
            var tb1 = document.getElementById("tagTable");
            var rCount = tb1.rows.length;
            for (var i = 1; i < rCount; i++) {
                tb1.deleteRow(1);
            }

            if('' == dtDefinedJson) dtDefinedJson = '[]';
            let definedDataTagObj = JSON.parse(dtDefinedJson);

            var oTable = document.getElementById("tagTable");
            var tbodyObj = oTable.tBodies[0];
            for(let key in definedDataTagObj ){
                let dtName = definedDataTagObj[key].name;
                if (dtName.toLocaleLowerCase().indexOf(s.toLocaleLowerCase()) > -1) {
                    var oTr = tbodyObj.insertRow();
                    var oTd = oTr.insertCell();
                    oTd.innerHTML = dtName;
                    oTd.title = dtName;
                    oTd = oTr.insertCell();
                    oTd.innerHTML = '<button class="delete-button" onclick="deleteTag(\''+ dtName +'\')">删除</button> <button class="locate-button" onclick="locateTag(\''+ dtName +'\')" >定位</button> <button class="normal-button" onclick="addTag(\''+ dtName +'\');">添加</button> ';
                }
            }
        }

        function addTag(tagName) {
            pageofficectrl.word.SetTextToSelection(tagName);
        }

        function locateTag(tagName){
            pageofficectrl.word.SelectionCollapse(0);

            if(isFromStart){
                if(lastOpTag == tagName){
                    pageofficectrl.word.HomeKey(6);
                }

                isFromStart = false;
            }

            if(!pageofficectrl.word.FindNextText(tagName)){
                alert('已经搜索到文档末尾。');
                isFromStart = true;
            }

            lastOpTag = tagName;
        }

        function deleteTag(tagName){
            let selectText = pageofficectrl.word.GetTextFromSelection();
            if(tagName != selectText){
                alert('请先执行‘'+tagName+'’的定位操作，然后再删除。');
            }else{
                pageofficectrl.word.SetTextToSelection('');
            }
        }

        function AfterDocumentOpened() {
            definedDataTagJson = pageofficectrl.word.DataTagsDefinedAsJson;
            loadData();
        }

    </script> 


    <div id="left-container">
        <div id="left-title">定义数据标签</div>
        <div class="input-group">
            <span style="font-size: 14px;">待添加标签：</span><input type="text" id="inputKey" oninput="loadData();" placeholder="请输入数据标签关键字搜索">
        </div>
        <div class="container">
            <table id="tagTable">
                <thead>
                <tr>
                    <th>数据标签</th>
                    <th style="width: 130px;">操作</th>
                </tr>
                </thead>
                <tbody>
                <!-- 数据行 -->
                </tbody>
            </table>
        </div>

    </div>

// Make sure to add code blocks to your code group

在最终需要动态填充数据到word模板中生成正式合同文件时，开发人员只管编写代码给所有的数据标签赋值即可，无需关心用户自定义的word模板中到底使用了哪些数据标签，因为那些没有使用的数据标签会被PageOffice自动忽略掉；而最终用户也可以根据自己的实际需要定义好word模板中各项数据及其位置，无需关心数据从哪里来，也不用事事都与开发人员沟通，当业务需求发生简单的变化时，可以自主修改word模板来满足新的需求。这样一来，不管是用户还是开发人员，都在一定程度上从这种纷杂多变的业务需求中解脱出来。