ASPOSE home

com.aspose.words
Class MergeFieldEventArgsBase

java.lang.Object
    extended by com.aspose.words.MergeFieldEventArgsBase
Direct Known Subclasses:
MergeFieldEventArgs, MergeImageFieldEventArgs

public abstract class MergeFieldEventArgsBase
extends java.lang.Object

Base class for MergeFieldEventArgs.
See Also:
MergeFieldEventArgs, MergeImageFieldEventArgs

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

Property Getters/Setters Detail

getDocument

public Document getDocument()
Returns the Document object for which the mail merge is performed.

getTableName

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

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

getFieldName

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

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

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

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