com.aspose.words

Class FieldMergingArgsBase

java.lang.Object

com.aspose.words.FieldMergingArgsBase

Direct Known Subclasses:

FieldMergingArgs, ImageFieldMergingArgs

public abstract class FieldMergingArgsBase
extends java.lang.Object

Base class for FieldMergingArgs and ImageFieldMergingArgs.

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

See Also:

FieldMergingArgs, ImageFieldMergingArgs

Constructor Summary

Constructors

Constructor and Description
FieldMergingArgsBase()

Method Summary

Modifier and Type	Method and Description
Document	getDocument() Returns the getDocument() object for which the mail merge is performed.
java.lang.String	getDocumentFieldName() Gets the name of the merge field as specified in the document.
FieldMergeField	getField() Gets the object that represents the current merge field.
java.lang.String	getFieldName() Gets the name of the merge field in the data source.
java.lang.Object	getFieldValue() Gets the value of the field from the data source.
int	getRecordIndex() Gets the zero based index of the record that is being merged.
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.
void	setFieldValue(java.lang.Object value) Sets the value of the field from the data source.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldMergingArgsBase

public FieldMergingArgsBase()

Method Detail

getDocument

public Document getDocument()

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

Returns:

The getDocument() 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.

Returns:

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.

Returns:

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".

Returns:

The name of the merge field in the data source.

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".

Returns:

The name of the merge field as specified in the document.

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. You can also replace the value by setting the property.

Returns:

The value of the field from the data source.

setFieldValue

public void setFieldValue(java.lang.Object value)

Sets 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. You can also replace the value by setting the property.

Parameters:

value - The value of the field from the data source.

getField

public FieldMergeField getField()

Gets the object that represents the current merge field.

Returns:

The object that represents the current merge field.