ASPOSE home

com.aspose.words
Class MergeFieldEventArgs

java.lang.Object
  extended by MergeFieldEventArgsBase
      extended by com.aspose.words.MergeFieldEventArgs

public class MergeFieldEventArgs
extends MergeFieldEventArgsBase

Provides data for the MergeField event.

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:
MergeFieldEventHandler

Property Getters/Setters Summary
DocumentgetDocument()→ inherited from MergeFieldEventArgsBase
           Returns the Document object for which the mail merge is performed.
java.lang.StringgetDocumentFieldName()→ inherited from MergeFieldEventArgsBase
           Gets the name of the merge field as specified in the document.
FieldgetField()→ inherited from MergeFieldEventArgsBase
           Gets the object that represents the current merge field.
java.lang.StringgetFieldName()→ inherited from MergeFieldEventArgsBase
           Gets the name of the merge field in the data source.
java.lang.ObjectgetFieldValue()→ inherited from MergeFieldEventArgsBase
           Gets the value of the field from the data source.
intgetRecordIndex()→ inherited from MergeFieldEventArgsBase
           Gets the zero based index of the record that is being merged.
java.lang.StringgetTableName()→ inherited from MergeFieldEventArgsBase
           Gets the name of the data table for the current merge operation or empty string if the name is not available.
java.lang.StringgetText()
voidsetText(java.lang.String value)
           Gets or sets the text that will be inserted into the document for the current merge field.
 

Property Getters/Setters Detail

getText/setText

public java.lang.String getText()

public void setText(java.lang.String value)
Gets or 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 FieldValue in place of the merge field.

If you set Text to a non empty string, the string will be inserted into the document in place of the merge field.

If you set Text to an empty string, the mail merge engine will remove the merge field.


getDocument

→ inherited from MergeFieldEventArgsBase
public Document getDocument()
Returns the Document object for which the mail merge is performed.

getTableName

→ inherited from MergeFieldEventArgsBase
public java.lang.String getTableName()
Gets the name of the data table for the current merge operation or empty string if the name is not available.

getRecordIndex

→ inherited from MergeFieldEventArgsBase
public int getRecordIndex()
Gets the zero based index of the record that is being merged.

getFieldName

→ inherited from MergeFieldEventArgsBase
public java.lang.String getFieldName()
Gets the name of the merge field in the data source.

If you have a mapping from a document field name to a different data source field name, then this is the mapped field name.

If you specified a field name prefix, for example "Image:MyFieldName" in the document, then FieldName returns field name without the prefix, that is "MyFieldName".


getDocumentFieldName

→ inherited from MergeFieldEventArgsBase
public java.lang.String getDocumentFieldName()
Gets the name of the merge field as specified in the document.

If you have a mapping from a document field name to a different data source field name, then this is the original field name as specified in the document.

If you specified a field name prefix, for example "Image:MyFieldName" in the document, then DocumentFieldName returns field name without the prefix, that is "MyFieldName".


getFieldValue

→ inherited from MergeFieldEventArgsBase
public java.lang.Object getFieldValue()
Gets the value of the field from the data source. This property contains a value that has just been selected from your data source for this field by the mail merge engine.

getField

→ inherited from MergeFieldEventArgsBase
public Field getField()
Gets the object that represents the current merge field.

See Also:
          Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
          Aspose.Words Support Forum - our preferred method of support.
          Aspose.Words Team - contact Aspose.Words Team.


ASPOSE home