pageoffice模板套红
转载:模板套红
模板套红
注意
本文中展示的代码均为关键代码,复制粘贴到您的项目中,按照实际的情况,例如文档路径,用户名等做适当修改即可使用。
在Web项目中处理Word文档,经常会用到Word模板,只不过这里的“模板”概念,都是指在Web项目中预先放置的doc、docx等扩展名的、真正的Word文档,对于Excel和PPT就是指xls、xlsx、ppt、pptx等扩展名的文件,而不是指微软Office的dot、dotx、xlt、xltx等扩展名的文件。对于模板的使用,有两种方式:
- 从模板起草文件。首先用户选择Word文件模板,通过程序代码从模板复制出新的文件,然后通过程序动态填充或用户手动填写新文件中各个模板项的内容,接下来用户编辑正文后,再进入领导审阅、核稿等环节,最后确认正式文件。详细请参考从模板起草文件。
- 编辑文件正文后,使用模板对文件套红。文件经过起草编辑正文、领导审阅、核稿等环节后,确认了正式的文件正文内容(此时文件中还没有红头),将文件正文内容套入到红头模板中,生成正式的文件。
本文重点介绍第二种方式,即编辑文件正文后,使用模板对文件套红。
Word模板文档的来源可以分为两种:
- 项目开发完成后模板固定不变的情况。一般由开发人员在项目开发过程中一边开发一边制作,也就是开发人员直接手动新建模板Word文件,编辑模板文件内容、样式、排版等,并在需要动态填充数据的位置插入数据区域或数据标签即可。
- 项目正式发布后,需要根据实际需求的变动,由用户自己重新编辑制作模板。此时就需要给用户开发一个模板管理模块,让用户自己新建、编辑模板Word文件内容、样式、排版等,并在需要动态填充数据的位置插入数据区域或数据标签。使用此方案的优点:实际需求变动后,项目无需修改代码再经过重新编译、重新发布等环节,这样就实现了项目的灵活性,显著降低了开发者的维护成本和工作量。详细请参考用户自定义模板中数据区域和用户自定义模板中数据标签。
如果用户套红使用的红头模板中包含了动态数据项,比如一个通知模板,里面包含了发文号、发文单位、发文日期等很多需要用程序或手动修改的数据项,那么就可以通过调用PageOffice的动态填充数据功能来完成,这样做不但减少了用户手动再次录入的工作量,提供了很好的用户体验,而且避免了用户手动编辑动态数据项的误操作,造成与数据库中相关值的不一致,还有就是编写代码调用PageOffice动态填充数据的工作量也是很少的;如果用户给文件套红时,使用的红头模板里面只是简单的红头,没有动态数据项,那就连动态填充数据的代码都无需编写了。接下来我们模拟一下编辑文件正文后,使用“通知模板”对文件套红的实现过程:
- 一般情况下,一个Web项目的文件起草模块都会给用户提供一个起草文件的表单让用户填写,用户提交保存后,创建新文件的同时,还会把这些数据保存到数据库中作为文件的关联属性数据。比如开发人员在Web系统中开发的起草通知功能是这样的:给用户提供了一个起草文件的页面(以下图为例),让用户填写各项表单数据,并点击“提交”按钮后,就会在项目的数据库中添加新的文件记录,同时创建一个空白的通知文件(比如文件名为“ZhenWen.docx”),并让用户在线打开此文件,编辑通知的正文内容。
用户编辑通知文件(ZhengWen.docx)的正文内容,并经过了领导的审阅、核稿保存后,文件内容如下图所示:
用户选择通知模板,对文件进行套红。假如通知模板文件为:template_tongzhi.docx,模板内容和样式如下图所示。
模板里面包含的数据区域有:
- 发文单位
PO_FaWenDanWei
- 年份
PO_NianFen
- 发文号
PO_FaWenHao
- 标题
PO_BiaoTi
- 主题词
PO_ZhuTiCi
- 打印份数
PO_DaYinFenShu
- 正文内容
PO_Content
- 发文单位
模板中包含的数据标签有:
- 发文日期
{#发文日期#}
- 发文日期
注意
在使用PageOffice开发的过程中,为了避免出现与用户自己定义的书签出现冲突,要求插入的书签名称必须以“PO_”开头。注意是字母o,不是数字0。在PageOffice的概念里提到的数据区域,本质上就是书签,但是只有“PO_”开头的书签才叫数据区域。
注意
数据标签本质上只是普通的文本,但是用一些特殊格式的文本做标记,比如“{日期}”、“{##日期##}”、“[日期]”、“【@日期】”等等,只要这些文本内容足够特殊,有别于文件中的正式内容,就可以当做数据标签。
- 用户选择模板开始套红时,通过执行程序代码复制通知模板为正式文件,比如:TongZhi008.docx,调用PageOffice在线打开TongZhi008.docx,并调用PageOffice的WordDocument对象动态填充各项数据,比如:发文单位、发文日期、标题、打印份数等到TongZhi008.docx中,同时调用WordDocument对象动态插入用户编辑的通知正文文件到TongZhi008.docx中“正文内容”所在位置,套红生成正式文件。如下图所示:
后端代码
复制通知模板(template_tongzhi.docx)为正式文件:TongZhi008.docx
File templateFile = new File("D:\\template_tongzhi.docx");
File newFile = new File("D:\\TongZhi008.docx");
Files.copy(templateFile.toPath(), newFile.toPath());
PageOffice在线打开TongZhi008.docx,并调用PageOffice的WordDocument对象进行套红操作
PageOfficeCtrl poCtrl = new PageOfficeCtrl(request);
WordDocument worddoc = new WordDocument();
// 为了代码简单,以下给数据区域赋值常量,正式开发时,可以从数据库中读取数据。
// ------ 给动态数据项赋值开始,如果红头模板中没有动态数据项,请忽略此段代码------
worddoc.openDataRegion("PO_FaWenDanWei").setValue("某某科技行政办公室");
worddoc.openDataRegion("PO_NianFen").setValue("2023");
worddoc.openDataRegion("PO_FaWenHao").setValue("008");
worddoc.openDataRegion("PO_BiaoTi").setValue("印发XX管理制度");
worddoc.openDataRegion("PO_ZhuTiCi").setValue("管理 制度 通知");
worddoc.openDataRegion("PO_DaYinFenShu").setValue("10");
// 发文日期为数据标签
worddoc.openDataTag("{#发文日期#}").setValue("2023年5月10日");
// ------ 给动态数据项数据赋值结束 ------
// 正文内容为用户编辑的通知正文文件ZhengWen.docx。以下代码为套红必须代码。
DataRegion drContent = worddoc.openDataRegion("PO_Content");
//“[word][/word]”标签的参数地址可以是“磁盘路径”,也可以是“文档url下载地址(不支持跨域)”
drContent.setValue("[word]D:\ZhengWen.docx[/word]");
poCtrl.setWriter(worddoc);//必须
poCtrl.WebOpen("D:\TongZhi008.docx", OpenModeType.docNormalEdit, "张三");
前端代码
本示例无前端关键代码。