com.aspose.words

Class FieldMergingArgs

java.lang.Object

com.aspose.words.FieldMergingArgsBase

com.aspose.words.FieldMergingArgs

public class FieldMergingArgs
extends FieldMergingArgsBase

Provides data for the MergeField event.

To learn more, visit the Mail Merge and Reporting documentation article.

The MergeField event occurs during mail merge when a simple mail merge field is encountered in the document. You can respond to this event to return text for the mail merge engine to insert into the document.

See Also:

IFieldMergingCallback

Method Summary

Modifier and Type	Method and Description
java.lang.String	getText() Gets the text that will be inserted into the document for the current merge field.
void	setText(java.lang.String value) Sets the text that will be inserted into the document for the current merge field.

Methods inherited from class com.aspose.words.FieldMergingArgsBase

getDocument, getDocumentFieldName, getField, getFieldName, getFieldValue, getRecordIndex, getTableName, setFieldValue

Methods inherited from class java.lang.Object

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

Method Detail

getText

public java.lang.String getText()

Gets the text that will be inserted into the document for the current merge field.

When your event handler is called, this property is set to null.

If you leave Text as null, the mail merge engine will insert FieldMergingArgsBase.getFieldValue() / FieldMergingArgsBase.setFieldValue(java.lang.Object) in place of the merge field.

If you set Text to any string (including empty), the string will be inserted into the document in place of the merge field.

Returns:

The text that will be inserted into the document for the current merge field.

setText

public void setText(java.lang.String value)

Sets the text that will be inserted into the document for the current merge field.

When your event handler is called, this property is set to null.

If you leave Text as null, the mail merge engine will insert FieldMergingArgsBase.getFieldValue() / FieldMergingArgsBase.setFieldValue(java.lang.Object) in place of the merge field.

If you set Text to any string (including empty), the string will be inserted into the document in place of the merge field.

Parameters:

value - The text that will be inserted into the document for the current merge field.