com.zhuozhengsoft.pageoffice.wordreader
类 WordDocument

java.lang.Object
  com.zhuozhengsoft.pageoffice.wordreader.WordDocument

public class WordDocument
extends java.lang.Object

WordDocument 类代表一个Word文档，用来读取用户输入到Word文档中的数据。

WordDocument 对象是PageOffice开发平台定义的Word数据读取对象。

com.zhuozhengsoft.pageoffice.wordreader.WordDocument 对象只能在 PageOfficeCtrl.SaveDataPage 指定的页面中创建。

版本：

2.0

作者：

北京卓正志远软件有限公司

构造方法摘要

WordDocument(HttpServletRequest request, HttpServletResponse response)
初始化 WordDocument 类的新实例。

方法摘要

void	close() 关闭 WordDocument 对象并返回保存成功的消息。
java.util.ArrayList<DataRegion>	getDataRegions() 获取控件提交的 DataRegion 集合。
java.lang.String	getFormField(java.lang.String name) 获取 PageOfficeCtrl 控件所在页面指定的Form控件的值。
DataRegion	openDataRegion(java.lang.String dataRegionName) 打开指定的数据区域，并返回 DataRegion 对象。
void	setCustomSaveResult(java.lang.String value) 设置开发者自定义保存结果。
void	showPage(int width, int height) 在浏览器里弹出对话框显示HTML格式的自定义保存结果。

从类 java.lang.Object 继承的方法

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

WordDocument

public WordDocument(HttpServletRequest request,
                    HttpServletResponse response)
             throws java.lang.Exception,
                    java.io.IOException

初始化 WordDocument 类的新实例。

com.zhuozhengsoft.pageoffice.wordreader.WordDocument 对象只能在 PageOfficeCtrl.SaveDataPage 指定的页面中创建。

抛出：

java.lang.Exception

java.io.IOException

方法详细信息

setCustomSaveResult

public void setCustomSaveResult(java.lang.String value)

设置开发者自定义保存结果。

下面的示例展示如何使用 CustomSaveResult 属性。

 WordDocument doc = new WordDocument(request, response);
 String strCompanyName = doc.openDataRegion("CompanyName").getValue();
 String strProductName = doc.openDataRegion("ProductName").getValue();
 
 //保存读取到的数据到数据库
 
 doc.setCustomSaveResult("我的返回值");
 doc.close();
 

然后在当前 JSP 页面里定义 OnWordDataRegionClick() 函数。

 <script language="javascript" type="text/javascript">
     function SaveDocument() {
         document.getElementById("PageOfficeCtrl1").WebSave();
         alert(document.getElementById("PageOfficeCtrl1").CustomSaveResult);//您可以判断CustomSaveResult编写自己的代码逻辑。
     }
 </script>
 

getDataRegions

public java.util.ArrayList<DataRegion> getDataRegions()
                                               throws java.io.IOException,
                                                      java.lang.Exception

获取控件提交的 DataRegion 集合。

抛出：

java.io.IOException

java.lang.Exception

openDataRegion

public DataRegion openDataRegion(java.lang.String dataRegionName)
                          throws java.io.IOException,
                                 java.lang.Exception

打开指定的数据区域，并返回 DataRegion 对象。

下面的示例展示了如何调用 openDataRegion 方法获取指定的数据区域的值。

 WordDocument doc = new WordDocument(request, response);
 String strCompanyName = doc.openDataRegion("CompanyName").getValue();
 String strProductName = doc.openDataRegion("ProductName").getValue();
 
 //保存读取到的数据到数据库
 
 doc.close(); //必须
 

参数：

dataRegionName - DataRegion 的名称。

返回：

返回 DataRegion 对象。

抛出：

java.io.IOException

java.lang.Exception

close

public void close()
           throws java.io.IOException

关闭 WordDocument 对象并返回保存成功的消息。

保存文档数据的代码成功执行后，您必须调用此方法关闭 WordDocument 对象。

抛出：

java.io.IOException

另请参见：

WordDocument.openDataRegion()方法中的示例代码，学习如何关闭 WordDocument 对象。

showPage

public void showPage(int width,
                     int height)
              throws java.io.IOException

在浏览器里弹出对话框显示HTML格式的自定义保存结果。

如果您需要弹出HTML格式的自定义保存结果对话框，您需要调用此方法。 对话框里显示的内容是 SaveDataPage 返回的页面。默认情况下，SaveDataPage 页面什么也不显示。您需要在 SaveDataPage 页面里设计友好的提示信息。

下面的示例展示如何使用 showPage 方法在浏览器里显示自定义保存错误对话框。

 WordDocument doc = new WordDocument(request, response);
 String strCompanyName = doc.openDataRegion("CompanyName").getValue();
 if(!strCompanyName.equals("")){
                //保存读取到的数据到数据库
 }
 else{
                out.println("保存失败！公司名称不能为空。"); // 简单输出错误信息，您可以设计友好的提示信息。
                doc.showPage(380, 200); // 如果公司名称为空，PageOfficeCtrl 控件就弹出对话框显示自定义错误页面。
 }
 doc.Close();
 

参数：

width - 对话框的宽度，以像素为单位。

height - 对话框的高度，以像素为单位。

抛出：

java.io.IOException

getFormField

public java.lang.String getFormField(java.lang.String name)
                              throws java.io.IOException,
                                     java.lang.Exception

获取 PageOfficeCtrl 控件所在页面指定的Form控件的值。

当 PageOfficeCtrl 提交文档时，您可以调用此方法获取PageOfficeCtrl 控件所在页面里Form控件的值。

注意：为了获取Form控件的值，Form控件必须包含 name 属性。

这里的Form控件包括输入框、下拉框、单选框、复选框、TextArea、隐藏域等类型的控件。

下面的示例展示如何使用 getFormField 获取 PageOfficeCtrl 控件所在页面Form域里的指定Form控件的值。

 WordDocument doc = new WordDocument(request, response);
 String strSubject = doc.getFormField("EditSubject"); 
 //保存读取到的数据到数据库
 String strCompanyName = doc.openDataRegion("CompanyName").getValue();
 doc.close();
 

参数：

name - Form控件的名称（name）。

返回：

返回Form控件的值。

抛出：

java.io.IOException

java.lang.Exception