com.aspose.words

Class FieldMergeField

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldMergeField

public class FieldMergeField
extends Field

Implements the MERGEFIELD field.

To learn more, visit the Working with Fields documentation article.

Remarks:

Retrieves the name of a data field within the merge characters in a mail merge main document. When the main document is merged with the selected data source, information from the specified data field is inserted in place of the merge field.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFieldName() Gets the name of a data field.
java.lang.String	getFieldNameNoPrefix() Returns just the name of the data field.
int	getSwitchType(java.lang.String switchName)
java.lang.String	getTextAfter() Gets the text to be inserted after the field if the field is not blank.
java.lang.String	getTextBefore() Gets the text to be inserted before the field if the field is not blank.
int	getType() Gets the Microsoft Word field type.
boolean	isMapped() Gets whether this field is a mapped field.
void	isMapped(boolean value) Sets whether this field is a mapped field.
boolean	isVerticalFormatting() Gets whether to enable character conversion for vertical formatting.
void	isVerticalFormatting(boolean value) Sets whether to enable character conversion for vertical formatting.
void	setFieldName(java.lang.String value) Sets the name of a data field.
void	setTextAfter(java.lang.String value) Sets the text to be inserted after the field if the field is not blank.
void	setTextBefore(java.lang.String value) Sets the text to be inserted before the field if the field is not blank.

Methods inherited from class com.aspose.words.Field

getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, update

Methods inherited from class java.lang.Object

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

Method Detail

getType

public int getType()

Gets the Microsoft Word field type.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Overrides:

getType in class Field

Returns:

The Microsoft Word field type. The returned value is one of FieldType constants.

getSwitchType

public int getSwitchType(java.lang.String switchName)

getFieldNameNoPrefix

public java.lang.String getFieldNameNoPrefix()

Returns just the name of the data field. Any prefix is stripped to the prefix property.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Returns:

Just the name of the data field.

getFieldName

public java.lang.String getFieldName()

Gets the name of a data field.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Returns:

The name of a data field.

setFieldName

public void setFieldName(java.lang.String value)
                  throws java.lang.Exception

Sets the name of a data field.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Parameters:

value - The name of a data field.

Throws:

java.lang.Exception

getTextBefore

public java.lang.String getTextBefore()

Gets the text to be inserted before the field if the field is not blank.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Returns:

The text to be inserted before the field if the field is not blank.

setTextBefore

public void setTextBefore(java.lang.String value)
                   throws java.lang.Exception

Sets the text to be inserted before the field if the field is not blank.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Parameters:

value - The text to be inserted before the field if the field is not blank.

Throws:

java.lang.Exception

getTextAfter

public java.lang.String getTextAfter()

Gets the text to be inserted after the field if the field is not blank.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Returns:

The text to be inserted after the field if the field is not blank.

setTextAfter

public void setTextAfter(java.lang.String value)
                  throws java.lang.Exception

Sets the text to be inserted after the field if the field is not blank.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Parameters:

value - The text to be inserted after the field if the field is not blank.

Throws:

java.lang.Exception

isMapped

public boolean isMapped()

Gets whether this field is a mapped field.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Returns:

Whether this field is a mapped field.

isMapped

public void isMapped(boolean value)
              throws java.lang.Exception

Sets whether this field is a mapped field.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Parameters:

value - Whether this field is a mapped field.

Throws:

java.lang.Exception

isVerticalFormatting

public boolean isVerticalFormatting()

Gets whether to enable character conversion for vertical formatting.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Returns:

Whether to enable character conversion for vertical formatting.

isVerticalFormatting

public void isVerticalFormatting(boolean value)
                          throws java.lang.Exception

Sets whether to enable character conversion for vertical formatting.

Examples:

Shows how to use MERGEFIELD fields to perform a mail merge.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Create a data table to be used as a mail merge data source.
 DataTable table = new DataTable("Employees");
 table.getColumns().add("Courtesy Title");
 table.getColumns().add("First Name");
 table.getColumns().add("Last Name");
 table.getRows().add("Mr.", "John", "Doe");
 table.getRows().add("Mrs.", "Jane", "Cardholder");

 // Insert a MERGEFIELD with a FieldName property set to the name of a column in the data source.
 FieldMergeField fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Courtesy Title");
 fieldMergeField.isMapped(true);
 fieldMergeField.isVerticalFormatting(false);

 // We can apply text before and after the value that this field accepts when the merge takes place.
 fieldMergeField.setTextBefore("Dear ");
 fieldMergeField.setTextAfter(" ");

 Assert.assertEquals(" MERGEFIELD  \"Courtesy Title\" \\m \\b \"Dear \" \\f \" \"", fieldMergeField.getFieldCode());
 Assert.assertEquals(FieldType.FIELD_MERGE_FIELD, fieldMergeField.getType());

 // Insert another MERGEFIELD for a different column in the data source.
 fieldMergeField = (FieldMergeField) builder.insertField(FieldType.FIELD_MERGE_FIELD, true);
 fieldMergeField.setFieldName("Last Name");
 fieldMergeField.setTextAfter(":");

 doc.updateFields();
 doc.getMailMerge().execute(table);

 Assert.assertEquals("Dear Mr. Doe:\fDear Mrs. Cardholder:", doc.getText().trim());
 
 

Parameters:

value - Whether to enable character conversion for vertical formatting.

Throws:

java.lang.Exception