DataRegion

概述

软件包

类

使用

树

已过时

索引

帮助

上一个类 下一个类

框架 无框架

摘要：嵌套 | 字段 | 构造方法 | 方法

详细信息：字段 | 构造方法 | 方法

com.zhuozhengsoft.pageoffice.wordwriter
类 DataRegion

java.lang.Object
  com.zhuozhengsoft.pageoffice.wordwriter.DataRegion

public class DataRegion
extends java.lang.Object
extends java.lang.Object

DataRegion 类，代表一个数据区域。

表示一个数据区域，用来填充数据区域及控制数据区域格式。您只能通过调用 WordDocument.openDataRegion 方法或 WordDocument.createDataRegion 方法获得 DataRegion 对象。

什么是数据区域？数据区域是Word文档中具有 "PO_" 前缀命名的书签所定位的文档区域。简单来说，数据区域就是一种特殊的Word书签对象，便于定位Word文档中的内容。数据区域是PageOffice开发平台中重要的技术概念，很多Word操作都需要调用DataRegion完成。

这里举个简单的例子说明什么是数据区域：假设开发者需要在待打开的Word文档指定位置处显示产品名称，就可以先手动打开此Word文档，在指定位置处插入书签"PO_ProductName"，保存文档。这样数据区域"ProductName"就定义好了。编写代码 doc.openDataRegion("ProductName").setValue("PageOffice"); 即可在此数据区域处生成想要的内容。

版本：: 2.0
作者：: 北京卓正志远软件有限公司

方法摘要
`Table`	`createTable(int numRows, int numColumns, WdAutoFitBehavior autoFitBehavior)` 在当前DataRegion位置处创建一个新的 Table。
`boolean`	`getEditing()` 获取 DataRegion 是否可以编辑。
`Font`	`getFont()` 获取字体对象。
`java.lang.String`	`getName()` 获取 DataRegion 的名称。
`ParagraphFormat`	`getParagraphFormat()` 获取段落格式对象。
`Shading`	`getShading()` 获取Shading对象。
`boolean`	`getSubmitAsFile()` 获取 DataRegion 在保存时是否作为Word文件提交。
`Table`	`openTable(int index)` 打开指定索引的Table。
`void`	`setEditing(boolean value)` 设置 DataRegion 是否可以编辑。
`void`	`setSubmitAsFile(boolean value)` 设置 DataRegion 在保存时是否作为Word文件提交。
`void`	`setValue(java.lang.String value)` 设置 DataRegion 的值。

从类 java.lang.Object 继承的方法
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

方法详细信息

getName

public java.lang.String getName()
                         throws java.io.IOException

获取 DataRegion 的名称。

抛出：: java.io.IOException

getEditing

public boolean getEditing()

获取 DataRegion 是否可以编辑。

setEditing

public void setEditing(boolean value)

设置 DataRegion 是否可以编辑。

当用OpenModeType.docSubmitForm模式打开Word文档后，只有Editing=true的数据区域处于可编辑状态，用户能够编辑或输入内容，除此之外文档的任何其他区域都是只读的，不能被编辑或输入内容。

此功能通常用来实现Word文档的可编辑区域控制或用Word文档作为Form输入表单提交用户输入。

另请参见：: WordDocument.openDataRegion()方法中的示例代码，学习如何设置数据区域可编辑。

getSubmitAsFile

public boolean getSubmitAsFile()

获取 DataRegion 在保存时是否作为Word文件提交。

setSubmitAsFile

public void setSubmitAsFile(boolean value)

设置 DataRegion 在保存时是否作为Word文件提交。

OpenModeType.docSubmitForm模式打开Word文档后，如果SubmitAsFile=true，则保存时可以获取当前数据区域包含的Word片段，这个片段是Word格式的二进制流文件，是独立的Word文件。

setValue

public void setValue(java.lang.String value)
              throws java.lang.Exception,
                     java.io.IOException

设置 DataRegion 的值。

抛出：: java.lang.Exception; java.io.IOException
另请参见：: WordDocument.openDataRegion()方法中的示例代码，学习如何设置数据区域的值。

getFont

public Font getFont()

获取字体对象。

返回：: Word中定义的字体对象。

getParagraphFormat

public ParagraphFormat getParagraphFormat()

获取段落格式对象。

返回：: Word中定义的段落格式对象。

getShading

public Shading getShading()

获取Shading对象。

返回：: Word中定义的Shading对象。

openTable

public Table openTable(int index)
                throws java.lang.Exception

打开指定索引的Table。

参数：: index - Table的索引，和Word中定义的概念完全一致。从"1"开始。
返回：: 返回 Table 对象。
抛出：: java.lang.Exception

createTable

public Table createTable(int numRows,
                         int numColumns,
                         WdAutoFitBehavior autoFitBehavior)
                  throws java.lang.Exception

在当前DataRegion位置处创建一个新的 Table。

参数：: numRows - 新表格的行数。; numColumns - 新表格的列数。; autoFitBehavior - 用于设置 Word 调整表格大小的“自动调整”规则。
返回：: 返回 Table 对象。
抛出：: java.lang.Exception