FieldMergingArgs
遗产: java.lang.Object, com.aspose.words.FieldMergingArgsBase
public class FieldMergingArgs extends FieldMergingArgsBase
提供数据MergeField事件。
要了解更多信息,请访问Mail Merge and Reporting文档文章。
这MergeField当在文档中遇到简单的邮件合并字段时,在邮件合并期间发生事件。您可以响应此事件以返回文本以供邮件合并引擎插入到文档中。
方法
方法 | 描述 |
---|---|
equals(Object arg0) | |
getClass() | |
getDocument() | 返回getDocument()执行邮件合并的对象。 |
getDocumentFieldName() | 获取文档中指定的合并字段的名称。 |
getField() | 获取表示当前合并字段的对象。 |
getFieldName() | 获取数据源中合并字段的名称。 |
getFieldValue() | 从数据源中获取字段的值。 |
getRecordIndex() | 获取正在合并的记录的从零开始的索引。 |
getTableName() | 获取当前合并操作的数据表的名称,如果名称不可用,则为空字符串。 |
getText() | 获取将插入到当前合并字段的文档中的文本。 |
hashCode() | |
notify() | |
notifyAll() | |
setFieldValue(Object value) | 设置来自数据源的字段值。 |
setText(String value) | 为当前合并字段设置将插入到文档中的文本。 |
toString() | |
wait() | |
wait(long arg0) | |
wait(long arg0, int arg1) |
equals(Object arg0)
public boolean equals(Object arg0)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | java.lang.Object |
退货: 布尔值
getClass()
public final native Class<?> getClass()
退货: java.lang.Class
getDocument()
public Document getDocument()
返回getDocument()执行邮件合并的对象。
退货: Document - 这getDocument()执行邮件合并的对象。
getDocumentFieldName()
public String getDocumentFieldName()
获取文档中指定的合并字段的名称。
如果您有从文档字段名称到不同数据源字段名称的映射,那么这是文档中指定的原始字段名称。
如果您在文档中指定了字段名称前缀,例如“Image:MyFieldName”,则DocumentFieldName返回不带前缀的字段名称,即“MyFieldName”。
退货: java.lang.String - 文档中指定的合并字段的名称。
getField()
public FieldMergeField getField()
获取表示当前合并字段的对象。
退货: FieldMergeField - 表示当前合并字段的对象。
getFieldName()
public String getFieldName()
获取数据源中合并字段的名称。
如果您有从文档字段名称到不同数据源字段名称的映射,那么这就是映射的字段名称。
如果您在文档中指定了字段名称前缀,例如“Image:MyFieldName”,则FieldName返回不带前缀的字段名称,即“MyFieldName”。
退货: java.lang.String - 数据源中合并字段的名称。
getFieldValue()
public Object getFieldValue()
从数据源中获取字段的值。此属性包含邮件合并引擎刚刚从您的数据源中为该字段选择的值。您还可以通过设置属性来替换值。
退货: java.lang.Object - 来自数据源的字段值。
getRecordIndex()
public int getRecordIndex()
获取正在合并的记录的从零开始的索引。
退货: int - 正在合并的记录的从零开始的索引。
getTableName()
public String getTableName()
获取当前合并操作的数据表的名称,如果名称不可用,则为空字符串。
退货: java.lang.String - 当前合并操作的数据表名称,如果名称不可用,则为空字符串。
getText()
public String getText()
获取将插入到当前合并字段的文档中的文本。
当您的事件处理程序被调用时,此属性设置为 null。
如果将文本保留为空,邮件合并引擎将插入FieldMergingArgsBase.getFieldValue() / FieldMergingArgsBase.setFieldValue(java.lang.Object)代替合并字段。
如果您将 Text 设置为任何字符串(包括空字符串),该字符串将被插入到文档中以代替合并字段。
退货: java.lang.String - 将插入到当前合并字段文档中的文本。
hashCode()
public native int hashCode()
退货: 整数
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setFieldValue(Object value)
public void setFieldValue(Object value)
设置来自数据源的字段值。此属性包含邮件合并引擎刚刚从您的数据源中为该字段选择的值。您还可以通过设置属性来替换值。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | java.lang.Object | 来自数据源的字段值。 |
setText(String value)
public void setText(String value)
为当前合并字段设置将插入到文档中的文本。
当您的事件处理程序被调用时,此属性设置为 null。
如果将文本保留为空,邮件合并引擎将插入FieldMergingArgsBase.getFieldValue() / FieldMergingArgsBase.setFieldValue(java.lang.Object)代替合并字段。
如果您将 Text 设置为任何字符串(包括空字符串),该字符串将被插入到文档中以代替合并字段。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | java.lang.String | 将为当前合并域插入到文档中的文本。 |
toString()
public String toString()
退货: java.lang.字符串
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | long | |
arg1 | int |