【JIT/极态云】技术文档-- Word模版

一、简介

Word模板是文件模板的其中一种应用，其核心功能在于预设格式、结构及特定变量，并能够根据实际需求动态地填充和更新数据。

具体而言，Word模板是一种预先设计好的文档框架，其中融合了可自定义的内容控件与占位符。这些元素涵盖了文本段落、标题、图片位置、表格、图表乃至页眉页脚等，所有这些都被精心布置以适应特定类型的文档需求。用户在采用Word模板时，仅需将模板中的占位符内容替换成实际信息，便能迅速创建出格式统一、专业呈现的信函、报告、简历、提案或是各类办公文件。

二、交互流程

创建一个Word模板，配置其模板名称及存储路径。

添加需要在模板中插入的变量，支持现有所有数据类型。

将生成好的文件数据复制其变量代码。

在自己的Word中对数据变量需要展示的位置进行排版，确认后上传即可。

三、模板变量代码

模板变量代码本质上是在变量的基础上提供模板样式方法，不同的样式方法可以将相同的变量数据展示出不同的渲染效果。

即在最终转换出的变量代码中格式一般为{{name.value.ToString}}三段式。代码以两个花括号（“{}”）包含。

1.变量名，第一段，为取值变量的名称，若为复杂类型则为a.b.c的连续取值；

2.属性值，第二段，为变量最终需要输出的值，可以调用只读函数或者读取属性；

3.样式方法，第三段，为对应输出值的展示样式，不同的值类型有不同的样式方法；

（一）文本类样式

类型	标题	函数名	备注	模板代码
文本类	展示单行文本	ToString	将对应输入以单行文本形式展示	{{a.value.ToString}}
文本类	展示多行文本	ToLine	依据输入中的回车转换为多行文本展示	{{a.value.ToLine}}
文本类	展示图片	ToPicture	将对应输入转换为图片展示；	{{a.value.ToPicture}}
文本类	展示超链接	ToLink	将对应输入转换为超链接展示；	{{a.value.ToLink}}
文本类	等宽换行	ToEquallyLine(int)	将对应输入按照指定长度切换行 默认不传，不换行	{{a.value.ToEquallyLine(int) }}
文本类	左截断指定长度	ToTrimLeft(int)	将对应输入截断指定长度展示 默认不传，不截断	{{a.value.ToTrimLeft(int) }}
文本类	右截断指定长度	ToTrimRight(int)	将对应输入截断指定长度展示 默认不传，不截断	{{a.value.ToTrimRight(int) }}

（二）数值类样式

类型	标题	函数名	备注	模板代码
数值类	展示数值	ToNum	将输入的数值直接展示	{{a.value.ToNum }}
数值类	保留指定小数位	ToRound(int)	将输入的数值保留指定位数（四舍五入） 默认不传代表都保留	{{a.value.ToRound(int) }}
数值类	截断指定位数	ToTruncate(int)	将输入的数值保留指定位数（截断） 默认不传代表不截断	{{a.value.ToTruncate(int) }}
数值类	取绝对值	ToAbs	将输入的数值取绝对值	{{a.value.ToAbs }}

（三）日期时间类样式

类型	标题	函数名	备注	模板代码
日期时间类	展示日期时间格式	ToDatetime	获取年月日时分秒YYMMDDthhmmss形式展示	{{a.value.ToDatetime }}
日期时间类	展示日期格式	ToDate	获取年月日YYMMDD形式展示；	{{a.value.ToDate }}
日期时间类	展示时间格式	ToTime	获取时分秒thhmmss形式展示；	{{a.value.ToTime }}

（四）多值类样式（复杂类型）

类型	标题	函数名	备注	模板代码
列表	展示多行数据	ToDataSet	获取对应输入以数据集合展示（多行数据、字典不区分横向/纵向，多行多列展示）	{% for each in data.value.ToDataSet %} {{each.name}}{{each.age}}{% endfor %}
列表	横向展示列表	ToList	获取数据集横向展示（对应多格语句） （默认获取文本值展示）	{% for each in data.value.ToList %}  {{each}} {% endfor %}
列表	纵向展示列表	ToList	获取数据集纵向展示（对应多格语句）  （默认获取文本值展示）	{% for each in data.value.ToList %}  {{each}} {% endfor %}
列表	横向展示图片列表	ToListPicture	获取图片数据集横向展示	{{a.value.ToListPicture}}
列表	纵向展示图片列表	ToListColumnPicture	获取图片数据集纵向展示	{{a.value.ToListColumnPicture}}
列表	展示列表首个数据	ToFirst	获取对应输入集合中第一个对象展示；（默认获取文本值展示）	{{a.value.ToFirst}}
列表	展示列表首张图片	ToFirstPicture	获取对应输入集合中第一个对象展示；（使用图片渲染）	{{a.value.ToFirstPicture}}
列表	展示列表最大值	ToMax	获取对应输入集合最大值	{{a.value.ToMax}}
列表	展示列表最小值	ToMin	获取对应输入集合最小值；	{{a.value.ToMin}}
列表	展示列表平均值	ToAvg	获取对应输入集合平均值；	{{a.value.ToAvg}}
列表	展示列表总和	ToSum	获取对应输入集合之和	{{a.value.ToSum}}
列表	展示列表个数	ToCount	获取对应输入集合个数	{{a.value.ToCount}}
字典	横向展示字典	ToDictionary	获取字典数据横向展示	{{a.value.ToDictionary.key}}
字典	纵向展示字典	ToDictionary	获取字典数据纵向展示	{{a.value.ToDictionary.key}}

在Word模板中可以对变量代码进行布局调整，在此基础上开发者也可以通过手写变量代码直接构建模板，不一定要依赖从系统中复制。

四、使用效果

文件模板一般在打印文件模板/生成附件函数中配合使用，这俩者都是将已有的模板变量进行赋值，然后将文件模板输出。

此时的生成附件逻辑就是将实际传入的变量赋值替换掉模板中的变量代码占位，从而生成最终的模板成果。

且每一次生成都可以赋予不同的实际值。

五、使用场景示例

例如，在采销人员针对意向客户准备合同时，可以根据对应客户的意向订单内容编制合同文件。这个合同文件的格式一般来说是不改变的，只是对于其中的客户信息、订单信息会有所不同，此时只需要将对应客户的信息赋值到文件模板中，就可以输出附件或打印了。

六、注意事项

1.针对部分特定样式，如展示图片/超链接/多行数据，要注意检查对应的变量输出能否满足数据要求。

2.在对变量代码进行布局时，若使用“居中对齐”没有达到理想打印效果，可以尝试将段落设置中的“间距-段后”修改为自动。

进一步了解极态云，体验产品？ 请访问 极态云官网