public class FieldMergeBarcode
Example:
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}
| Constructor Summary |
|---|
| Property Getters/Setters Summary | ||
|---|---|---|
boolean | getAddStartStopChar() | |
void | setAddStartStopChar(booleanvalue) | |
| Gets or sets whether to add Start/Stop characters for barcode types NW7 and CODE39. | ||
java.lang.String | getBackgroundColor() | |
void | setBackgroundColor(java.lang.Stringvalue) | |
| Gets or sets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF] | ||
java.lang.String | getBarcodeType() | |
void | setBarcodeType(java.lang.Stringvalue) | |
| Gets or sets the barcode type (QR, etc.) | ||
java.lang.String | getBarcodeValue() | |
void | setBarcodeValue(java.lang.Stringvalue) | |
| Gets or sets the barcode value. | ||
java.lang.String | getCaseCodeStyle() | |
void | setCaseCodeStyle(java.lang.Stringvalue) | |
| Gets or sets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD] | ||
java.lang.String | getDisplayResult() | |
Gets the text that represents the displayed field result.
|
||
boolean | getDisplayText() | |
void | setDisplayText(booleanvalue) | |
| Gets or sets whether to display barcode data (text) along with image. | ||
FieldEnd | getEnd() | |
Gets the node that represents the field end.
|
||
java.lang.String | getErrorCorrectionLevel() | |
void | setErrorCorrectionLevel(java.lang.Stringvalue) | |
| Gets or sets an error correction level of QR Code. Valid values are [0, 3]. | ||
boolean | getFixCheckDigit() | |
void | setFixCheckDigit(booleanvalue) | |
| Gets or sets whether to fix the check digit if it’s invalid. | ||
java.lang.String | getForegroundColor() | |
void | setForegroundColor(java.lang.Stringvalue) | |
| Gets or sets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF] | ||
FieldFormat | getFormat() | |
Gets a |
||
boolean | isDirty() | |
void | isDirty(booleanvalue) | |
| Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. | ||
boolean | isLocked() | |
void | isLocked(booleanvalue) | |
| Gets or sets whether the field is locked (should not recalculate its result). | ||
int | getLocaleId() | |
void | setLocaleId(intvalue) | |
| Gets or sets the LCID of the field. | ||
java.lang.String | getPosCodeStyle() | |
void | setPosCodeStyle(java.lang.Stringvalue) | |
| Gets or sets the style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). The valid values (case insensitive) are [STD|SUP2|SUP5|CASE]. | ||
java.lang.String | getResult() | |
void | setResult(java.lang.Stringvalue) | |
| Gets or sets text that is between the field separator and field end. | ||
java.lang.String | getScalingFactor() | |
void | setScalingFactor(java.lang.Stringvalue) | |
| Gets or sets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000] | ||
FieldSeparator | getSeparator() | |
Gets the node that represents the field separator. Can be null.
|
||
FieldStart | getStart() | |
Gets the node that represents the start of the field.
|
||
java.lang.String | getSymbolHeight() | |
void | setSymbolHeight(java.lang.Stringvalue) | |
| Gets or sets the height of the symbol. The units are in TWIPS (1/1440 inch). | ||
java.lang.String | getSymbolRotation() | |
void | setSymbolRotation(java.lang.Stringvalue) | |
| Gets or sets the rotation of the barcode symbol. Valid values are [0, 3] | ||
int | getType() | |
Gets the Microsoft Word field type.
The value of the property is FieldType integer constant. |
||
| Method Summary | ||
|---|---|---|
java.lang.String | getFieldCode() | |
Returns text between field start and field separator (or field end if there is no separator).
Both field code and field result of child fields are included.
|
||
java.lang.String | getFieldCode(boolean includeChildFieldCodes) | |
Returns text between field start and field separator (or field end if there is no separator).
|
||
Node | remove() | |
Removes the field from the document. Returns a node right after the field. If the field's end is the last child
of its parent node, returns its parent paragraph. If the field is already removed, returns null.
|
||
boolean | unlink() | |
Performs the field unlink.
|
||
void | update() | |
Performs the field update. Throws if the field is being updated already.
|
||
void | update(boolean ignoreMergeFormat) | |
Performs a field update. Throws if the field is being updated already.
|
||
public boolean getAddStartStopChar() / public void setAddStartStopChar(boolean value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public java.lang.String getBackgroundColor() / public void setBackgroundColor(java.lang.String value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public java.lang.String getBarcodeType() / public void setBarcodeType(java.lang.String value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public java.lang.String getBarcodeValue() / public void setBarcodeValue(java.lang.String value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public java.lang.String getCaseCodeStyle() / public void setCaseCodeStyle(java.lang.String value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public java.lang.String getDisplayResult()
public boolean getDisplayText() / public void setDisplayText(boolean value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public FieldEnd getEnd()
Example:
Shows how to work with a document's field collection.
public void fieldCollection() throws Exception {
// Open a document that has fields
Document doc = new Document(getMyDir() + "Document.ContainsFields.docx");
// Get the collection that contains all the fields in a document
FieldCollection fields = doc.getRange().getFields();
Assert.assertEquals(fields.getCount(), 6);
// Iterate over the field collection and print contents and type of every field using a custom visitor implementation
FieldVisitor fieldVisitor = new FieldVisitor();
Iterator<Field> fieldEnumerator = fields.iterator();
while (fieldEnumerator.hasNext()) {
if (fieldEnumerator.next() != null) {
Field currentField = fieldEnumerator.next();
currentField.getStart().accept(fieldVisitor);
if (currentField.getSeparator() != null) {
currentField.getSeparator().accept(fieldVisitor);
}
currentField.getEnd().accept(fieldVisitor);
} else {
System.out.println("There are no fields in the document.");
}
}
System.out.println(fieldVisitor.getText());
// Get a field to remove itself
fields.get(0).remove();
Assert.assertEquals(fields.getCount(), 5);
// Remove a field by reference
Field lastField = fields.get(3);
fields.remove(lastField);
Assert.assertEquals(fields.getCount(), 4);
// Remove a field by index
fields.removeAt(2);
Assert.assertEquals(fields.getCount(), 3);
// Remove all fields from the document
fields.clear();
Assert.assertEquals(fields.getCount(), 0);
}
/// <summary>
/// Document visitor implementation that prints field info
/// </summary>
public static class FieldVisitor extends DocumentVisitor {
public FieldVisitor() {
mBuilder = new StringBuilder();
}
/// <summary>
/// Gets the plain text of the document that was accumulated by the visitor.
/// </summary>
public String getText() {
return mBuilder.toString();
}
/// <summary>
/// Called when a FieldStart node is encountered in the document.
/// </summary>
public int visitFieldStart(final FieldStart fieldStart) {
mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n");
mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n");
mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n");
return VisitorAction.CONTINUE;
}
/// <summary>
/// Called when a FieldSeparator node is encountered in the document.
/// </summary>
public int visitFieldSeparator(final FieldSeparator fieldSeparator) {
mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n");
return VisitorAction.CONTINUE;
}
/// <summary>
/// Called when a FieldEnd node is encountered in the document.
/// </summary>
public int visitFieldEnd(final FieldEnd fieldEnd) {
mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n");
return VisitorAction.CONTINUE;
}
private StringBuilder mBuilder;
}public java.lang.String getErrorCorrectionLevel() / public void setErrorCorrectionLevel(java.lang.String value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public boolean getFixCheckDigit() / public void setFixCheckDigit(boolean value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public java.lang.String getForegroundColor() / public void setForegroundColor(java.lang.String value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public FieldFormat getFormat()
Example:
Shows how to formatting fields
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Use a document builder to insert field with no format
Field field = builder.insertField("= 2 + 3");
// We can format our field here instead of in the field code
FieldFormat format = field.getFormat();
format.setNumericFormat("$###.00");
field.update();
// Apply a date/time format
field = builder.insertField("DATE");
format = field.getFormat();
format.setDateTimeFormat("dddd, MMMM dd, yyyy");
field.update();
// Apply 2 general formats at the same time
field = builder.insertField("= 25 + 33");
format = field.getFormat();
format.getGeneralFormats().add(GeneralFormat.LOWERCASE_ROMAN);
format.getGeneralFormats().add(GeneralFormat.UPPER);
field.update();
int index = 0;
Iterator<Integer> generalFormatEnumerator = format.getGeneralFormats().iterator();
while (generalFormatEnumerator.hasNext()) {
System.out.println(MessageFormat.format("General format index {0}: {1}", index++, generalFormatEnumerator.toString()));
}
Assert.assertEquals("LVIII", field.getResult());
Assert.assertEquals(2, format.getGeneralFormats().getCount());
Assert.assertEquals(format.getGeneralFormats().get(0), GeneralFormat.LOWERCASE_ROMAN);
// Removing field formats
format.getGeneralFormats().remove(GeneralFormat.LOWERCASE_ROMAN);
format.getGeneralFormats().removeAt(0);
Assert.assertEquals(format.getGeneralFormats().getCount(), 0);
field.update();
// Our field has no general formats left and is back to default form
Assert.assertEquals(field.getResult(), "58");public boolean isDirty() / public void isDirty(boolean value)
Example:
Shows how to use special property for updating field result
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Field fieldToc = builder.insertTableOfContents("\\o \"1-3\" \\h \\z \\u");
fieldToc.isDirty(true);public boolean isLocked() / public void isLocked(boolean value)
Example:
Demonstrates how to retrieve the field class from an existing FieldStart node in the document.
Document doc = new Document(getMyDir() + "Document.TableOfContents.doc");
FieldChar fieldStart = (FieldChar) doc.getChild(NodeType.FIELD_START, 0, true);
Assert.assertEquals(fieldStart.getFieldType(), FieldType.FIELD_TOC);
Assert.assertEquals(fieldStart.isDirty(), true);
Assert.assertEquals(fieldStart.isLocked(), false);
// Retrieve the facade object which represents the field in the document.
Field field = fieldStart.getField();
Assert.assertEquals(false, field.isLocked());
Assert.assertEquals(" TOC \\o \"1-3\" \\h \\z \\u ", field.getFieldCode());
// This updates only this field in the document.
field.update();public int getLocaleId() / public void setLocaleId(int value)
Example:
Get or sets locale for fields
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Field field = builder.insertField("DATE \\* MERGEFORMAT");
field.setLocaleId(2064);
ByteArrayOutputStream dstStream = new ByteArrayOutputStream();
doc.save(dstStream, SaveFormat.DOCX);
Field newField = doc.getRange().getFields().get(0);
Assert.assertEquals(newField.getLocaleId(), 2064);public java.lang.String getPosCodeStyle() / public void setPosCodeStyle(java.lang.String value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public java.lang.String getResult() / public void setResult(java.lang.String value)
Example:
Inserts a field into a document using DocumentBuilder and FieldCode.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");
// Update this particular field in the document so we can get the FieldResult.
dateField.update();
// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));
// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));
// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));
// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();public java.lang.String getScalingFactor() / public void setScalingFactor(java.lang.String value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public FieldSeparator getSeparator()
Example:
Shows how to work with a document's field collection.
public void fieldCollection() throws Exception {
// Open a document that has fields
Document doc = new Document(getMyDir() + "Document.ContainsFields.docx");
// Get the collection that contains all the fields in a document
FieldCollection fields = doc.getRange().getFields();
Assert.assertEquals(fields.getCount(), 6);
// Iterate over the field collection and print contents and type of every field using a custom visitor implementation
FieldVisitor fieldVisitor = new FieldVisitor();
Iterator<Field> fieldEnumerator = fields.iterator();
while (fieldEnumerator.hasNext()) {
if (fieldEnumerator.next() != null) {
Field currentField = fieldEnumerator.next();
currentField.getStart().accept(fieldVisitor);
if (currentField.getSeparator() != null) {
currentField.getSeparator().accept(fieldVisitor);
}
currentField.getEnd().accept(fieldVisitor);
} else {
System.out.println("There are no fields in the document.");
}
}
System.out.println(fieldVisitor.getText());
// Get a field to remove itself
fields.get(0).remove();
Assert.assertEquals(fields.getCount(), 5);
// Remove a field by reference
Field lastField = fields.get(3);
fields.remove(lastField);
Assert.assertEquals(fields.getCount(), 4);
// Remove a field by index
fields.removeAt(2);
Assert.assertEquals(fields.getCount(), 3);
// Remove all fields from the document
fields.clear();
Assert.assertEquals(fields.getCount(), 0);
}
/// <summary>
/// Document visitor implementation that prints field info
/// </summary>
public static class FieldVisitor extends DocumentVisitor {
public FieldVisitor() {
mBuilder = new StringBuilder();
}
/// <summary>
/// Gets the plain text of the document that was accumulated by the visitor.
/// </summary>
public String getText() {
return mBuilder.toString();
}
/// <summary>
/// Called when a FieldStart node is encountered in the document.
/// </summary>
public int visitFieldStart(final FieldStart fieldStart) {
mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n");
mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n");
mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n");
return VisitorAction.CONTINUE;
}
/// <summary>
/// Called when a FieldSeparator node is encountered in the document.
/// </summary>
public int visitFieldSeparator(final FieldSeparator fieldSeparator) {
mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n");
return VisitorAction.CONTINUE;
}
/// <summary>
/// Called when a FieldEnd node is encountered in the document.
/// </summary>
public int visitFieldEnd(final FieldEnd fieldEnd) {
mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n");
return VisitorAction.CONTINUE;
}
private StringBuilder mBuilder;
}public FieldStart getStart()
Example:
Shows how to work with a document's field collection.
public void fieldCollection() throws Exception {
// Open a document that has fields
Document doc = new Document(getMyDir() + "Document.ContainsFields.docx");
// Get the collection that contains all the fields in a document
FieldCollection fields = doc.getRange().getFields();
Assert.assertEquals(fields.getCount(), 6);
// Iterate over the field collection and print contents and type of every field using a custom visitor implementation
FieldVisitor fieldVisitor = new FieldVisitor();
Iterator<Field> fieldEnumerator = fields.iterator();
while (fieldEnumerator.hasNext()) {
if (fieldEnumerator.next() != null) {
Field currentField = fieldEnumerator.next();
currentField.getStart().accept(fieldVisitor);
if (currentField.getSeparator() != null) {
currentField.getSeparator().accept(fieldVisitor);
}
currentField.getEnd().accept(fieldVisitor);
} else {
System.out.println("There are no fields in the document.");
}
}
System.out.println(fieldVisitor.getText());
// Get a field to remove itself
fields.get(0).remove();
Assert.assertEquals(fields.getCount(), 5);
// Remove a field by reference
Field lastField = fields.get(3);
fields.remove(lastField);
Assert.assertEquals(fields.getCount(), 4);
// Remove a field by index
fields.removeAt(2);
Assert.assertEquals(fields.getCount(), 3);
// Remove all fields from the document
fields.clear();
Assert.assertEquals(fields.getCount(), 0);
}
/// <summary>
/// Document visitor implementation that prints field info
/// </summary>
public static class FieldVisitor extends DocumentVisitor {
public FieldVisitor() {
mBuilder = new StringBuilder();
}
/// <summary>
/// Gets the plain text of the document that was accumulated by the visitor.
/// </summary>
public String getText() {
return mBuilder.toString();
}
/// <summary>
/// Called when a FieldStart node is encountered in the document.
/// </summary>
public int visitFieldStart(final FieldStart fieldStart) {
mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n");
mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n");
mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n");
return VisitorAction.CONTINUE;
}
/// <summary>
/// Called when a FieldSeparator node is encountered in the document.
/// </summary>
public int visitFieldSeparator(final FieldSeparator fieldSeparator) {
mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n");
return VisitorAction.CONTINUE;
}
/// <summary>
/// Called when a FieldEnd node is encountered in the document.
/// </summary>
public int visitFieldEnd(final FieldEnd fieldEnd) {
mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n");
return VisitorAction.CONTINUE;
}
private StringBuilder mBuilder;
}public java.lang.String getSymbolHeight() / public void setSymbolHeight(java.lang.String value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public java.lang.String getSymbolRotation() / public void setSymbolRotation(java.lang.String value)
Example:
Shows how to use MERGEBARCODE fields to integrate barcodes into mail merge operations.
public void fieldMergeBarcodeQR() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a QR code
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("QR");
// In a DISPLAYBARCODE field, the BarcodeValue attribute decides what value the barcode will display
// However in our MERGEBARCODE fields, it has the same function as the FieldName attribute of a MERGEFIELD
field.setBarcodeValue("MyQRCode");
field.setBackgroundColor("0xF8BD69");
field.setForegroundColor("0xB5413B");
field.setErrorCorrectionLevel("3");
field.setScalingFactor("250");
field.setSymbolHeight("1000");
field.setSymbolRotation("0");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyQRCode QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0");
builder.writeln();
// Create a data source for our mail merge
// This source is a data table, whose column names correspond to the FieldName attributes of MERGEFIELD fields
// as well as BarcodeValue attributes of DISPLAYBARCODE fields
DataTable table = createTable("Barcodes", new String[]{"MyQRCode"},
new String[][]{{"ABC123"}, {"DEF456"}});
// During the mail merge, all our MERGEBARCODE fields will be converted into DISPLAYBARCODE fields,
// with values from the data table rows deposited into corresponding BarcodeValue attributes
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"ABC123\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"DEF456\" QR \\q 3 \\s 250 \\h 1000 \\r 0 \\b 0xF8BD69 \\f 0xB5413B");
doc.save(getArtifactsDir() + "Field.MergeBarcode_QR.docx");
}
public void fieldMergeBarcodeEAN13() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a EAN13 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("EAN13");
field.setBarcodeValue("MyEAN13Barcode");
field.setDisplayText(true);
field.setPosCodeStyle("CASE");
field.setFixCheckDigit(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyEAN13Barcode EAN13 \\t \\p CASE \\x");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyEAN13Barcode"},
new String[][]{{"501234567890"}, {"123456789012"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"501234567890\" EAN13 \\t \\p CASE \\x");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"123456789012\" EAN13 \\t \\p CASE \\x");
doc.save(getArtifactsDir() + "Field.MergeBarcode_EAN13.docx");
}
public void fieldMergeBarcodeCODE39() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a CODE39 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("CODE39");
field.setBarcodeValue("MyCODE39Barcode");
field.setAddStartStopChar(true);
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyCODE39Barcode CODE39 \\d");
builder.writeln();
DataTable table = createTable("Barcodes", new String[]{"MyCODE39Barcode"},
new String[][]{{"12345ABCDE"}, {"67890FGHIJ"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode(), "DISPLAYBARCODE \"12345ABCDE\" CODE39 \\d");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode(), "DISPLAYBARCODE \"67890FGHIJ\" CODE39 \\d");
doc.save(getArtifactsDir() + "Field.MergeBarcode_CODE39.docx");
}
public void fieldMergeBarcodeITF14() throws Exception {
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a ITF14 barcode
FieldMergeBarcode field = (FieldMergeBarcode) builder.insertField(FieldType.FIELD_MERGE_BARCODE, true);
field.setBarcodeType("ITF14");
field.setBarcodeValue("MyITF14Barcode");
field.setCaseCodeStyle("STD");
Assert.assertEquals(field.getFieldCode(), " MERGEBARCODE MyITF14Barcode ITF14 \\c STD");
DataTable table = createTable("Barcodes", new String[]{"MyITF14Barcode"},
new String[][]{{"09312345678907"}, {"1234567891234"}});
doc.getMailMerge().execute(table);
Assert.assertEquals(doc.getRange().getFields().get(0).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(1).getType(), FieldType.FIELD_DISPLAY_BARCODE);
Assert.assertEquals(doc.getRange().getFields().get(0).getFieldCode().toString(), "DISPLAYBARCODE \"09312345678907\" ITF14 \\c STD");
Assert.assertEquals(doc.getRange().getFields().get(1).getFieldCode().toString(), "DISPLAYBARCODE \"1234567891234\" ITF14 \\c STD");
doc.save(getArtifactsDir() + "Field.MergeBarcode_ITF14.docx");
}
/// <summary>
/// Creates a DataTable named by dataTableName, adds a column for every element in columnNames
/// and fills rows with data from dataSet
/// </summary>
@Test(enabled = false)
public DataTable createTable(final String dataTableName, final String[] columnNames, final Object[][] dataSet) {
if (!new String(dataTableName).equals("") || columnNames.length != 0) {
DataTable table = new DataTable(dataTableName);
for (String columnName : columnNames) {
table.getColumns().add(columnName);
}
for (Object data : dataSet) {
table.getRows().add(data);
}
return table;
}
throw new IllegalArgumentException("DataTable name and Column name must be declared.");
}public int getType()
Example:
Inserts a field into a document using DocumentBuilder and FieldCode.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");
// Update this particular field in the document so we can get the FieldResult.
dateField.update();
// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));
// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));
// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));
// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();public java.lang.String getFieldCode()
Example:
Inserts a field into a document using DocumentBuilder and FieldCode.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");
// Update this particular field in the document so we can get the FieldResult.
dateField.update();
// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));
// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));
// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));
// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();Example:
Shows how to get text between field start and field separator (or field end if there is no separator)
Document doc = new Document(getMyDir() + "Field.FieldCode.docx");
for (Field field : doc.getRange().getFields()) {
if (field.getType() == FieldType.FIELD_IF) {
FieldIf fieldIf = (FieldIf) field;
String fieldCode = fieldIf.getFieldCode();
if (containsNestedFields) {
fieldCode = fieldIf.getFieldCode(true);
} else {
fieldCode = fieldIf.getFieldCode(false);
}
}
}public java.lang.String getFieldCode(boolean includeChildFieldCodes)
includeChildFieldCodes - True if child field codes should be included.
Example:
Shows how to get text between field start and field separator (or field end if there is no separator)
Document doc = new Document(getMyDir() + "Field.FieldCode.docx");
for (Field field : doc.getRange().getFields()) {
if (field.getType() == FieldType.FIELD_IF) {
FieldIf fieldIf = (FieldIf) field;
String fieldCode = fieldIf.getFieldCode();
if (containsNestedFields) {
fieldCode = fieldIf.getFieldCode(true);
} else {
fieldCode = fieldIf.getFieldCode(false);
}
}
}public Node remove() throws java.lang.Exception
Example:
Shows how to work with a document's field collection.
public void fieldCollection() throws Exception {
// Open a document that has fields
Document doc = new Document(getMyDir() + "Document.ContainsFields.docx");
// Get the collection that contains all the fields in a document
FieldCollection fields = doc.getRange().getFields();
Assert.assertEquals(fields.getCount(), 6);
// Iterate over the field collection and print contents and type of every field using a custom visitor implementation
FieldVisitor fieldVisitor = new FieldVisitor();
Iterator<Field> fieldEnumerator = fields.iterator();
while (fieldEnumerator.hasNext()) {
if (fieldEnumerator.next() != null) {
Field currentField = fieldEnumerator.next();
currentField.getStart().accept(fieldVisitor);
if (currentField.getSeparator() != null) {
currentField.getSeparator().accept(fieldVisitor);
}
currentField.getEnd().accept(fieldVisitor);
} else {
System.out.println("There are no fields in the document.");
}
}
System.out.println(fieldVisitor.getText());
// Get a field to remove itself
fields.get(0).remove();
Assert.assertEquals(fields.getCount(), 5);
// Remove a field by reference
Field lastField = fields.get(3);
fields.remove(lastField);
Assert.assertEquals(fields.getCount(), 4);
// Remove a field by index
fields.removeAt(2);
Assert.assertEquals(fields.getCount(), 3);
// Remove all fields from the document
fields.clear();
Assert.assertEquals(fields.getCount(), 0);
}
/// <summary>
/// Document visitor implementation that prints field info
/// </summary>
public static class FieldVisitor extends DocumentVisitor {
public FieldVisitor() {
mBuilder = new StringBuilder();
}
/// <summary>
/// Gets the plain text of the document that was accumulated by the visitor.
/// </summary>
public String getText() {
return mBuilder.toString();
}
/// <summary>
/// Called when a FieldStart node is encountered in the document.
/// </summary>
public int visitFieldStart(final FieldStart fieldStart) {
mBuilder.append("Found field: " + fieldStart.getFieldType() + "\r\n");
mBuilder.append("\tField code: " + fieldStart.getField().getFieldCode() + "\r\n");
mBuilder.append("\tDisplayed as: " + fieldStart.getField().getResult() + "\r\n");
return VisitorAction.CONTINUE;
}
/// <summary>
/// Called when a FieldSeparator node is encountered in the document.
/// </summary>
public int visitFieldSeparator(final FieldSeparator fieldSeparator) {
mBuilder.append("\tFound separator: " + fieldSeparator.getText() + "\r\n");
return VisitorAction.CONTINUE;
}
/// <summary>
/// Called when a FieldEnd node is encountered in the document.
/// </summary>
public int visitFieldEnd(final FieldEnd fieldEnd) {
mBuilder.append("End of field: " + fieldEnd.getFieldType() + "\r\n");
return VisitorAction.CONTINUE;
}
private StringBuilder mBuilder;
}Example:
Inserts a field into a document using DocumentBuilder and FieldCode.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");
// Update this particular field in the document so we can get the FieldResult.
dateField.update();
// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));
// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));
// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));
// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();
public boolean unlink()
throws java.lang.ExceptionReplaces the field with its most recent result.
Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.
True if the field has been unlinked, otherwise false.
Example:
Shows how to unlink specific fieldDocument doc = new Document(getMyDir() + "Field.UnlinkFields.docx"); doc.getRange().getFields().get(1).unlink();
public void update()
throws java.lang.ExceptionExample:
Inserts a field into a document using DocumentBuilder and FieldCode.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");
// Update this particular field in the document so we can get the FieldResult.
dateField.update();
// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));
// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));
// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));
// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();
public void update(boolean ignoreMergeFormat)
throws java.lang.ExceptionignoreMergeFormat -
If true then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.
Example:
Shows a way to update a field ignoring the MERGEFORMAT switch
LoadOptions loadOptions = new LoadOptions();
loadOptions.setPreserveIncludePictureField(true);
Document doc = new Document(getMyDir() + "Field.UpdateFieldIgnoringMergeFormat.docx", loadOptions);
for (Field field : doc.getRange().getFields()) {
if (((field.getType()) == (FieldType.FIELD_INCLUDE_PICTURE))) {
FieldIncludePicture includePicture = (FieldIncludePicture) field;
includePicture.setSourceFullName(getImageDir() + "dotnet-logo.png");
includePicture.update(true);
}
}
doc.updateFields();
doc.save(getArtifactsDir() + "Field.UpdateFieldIgnoringMergeFormat.docx");