com.aspose.words
Class BarcodeParameters

java.lang.Object
    extended by com.aspose.words.BarcodeParameters

public class BarcodeParameters 
extends java.lang.Object

Container class for barcode parameters to pass-through to BarcodeGenerator. The set of parameters are according to DISPLAYBARCODE field options. See the exact list at

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

Constructor Summary
BarcodeParameters()
          
 
Property Getters/Setters Summary
booleangetAddStartStopChar()
voidsetAddStartStopChar(boolean value)
           Whether to add Start/Stop characters for barcode types NW7 and CODE39.
java.lang.StringgetBackgroundColor()
voidsetBackgroundColor(java.lang.String value)
           Bar code background color (0x000000 - 0xFFFFFF)
java.lang.StringgetBarcodeType()
voidsetBarcodeType(java.lang.String value)
           Bar code type.
java.lang.StringgetBarcodeValue()
voidsetBarcodeValue(java.lang.String value)
           Data to be encoded.
java.lang.StringgetCaseCodeStyle()
voidsetCaseCodeStyle(java.lang.String value)
           Style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD]
booleangetDisplayText()
voidsetDisplayText(boolean value)
           Whether to display barcode data (text) along with image.
java.lang.StringgetErrorCorrectionLevel()
voidsetErrorCorrectionLevel(java.lang.String value)
           Error correction level of QR Code. Valid values are [0, 3].
java.lang.StringgetFacingIdentificationMark()
voidsetFacingIdentificationMark(java.lang.String value)
           Type of a Facing Identification Mark (FIM).
booleangetFixCheckDigit()
voidsetFixCheckDigit(boolean value)
           Whether to fix the check digit if it’s invalid.
java.lang.StringgetForegroundColor()
voidsetForegroundColor(java.lang.String value)
           Bar code foreground color (0x000000 - 0xFFFFFF)
booleanisBookmark()
voidisBookmark(boolean value)
           Whether PostalAddress is the name of a bookmark.
booleanisUSPostalAddress()
voidisUSPostalAddress(boolean value)
           Whether PostalAddress is a U.S. postal address.
java.lang.StringgetPosCodeStyle()
voidsetPosCodeStyle(java.lang.String value)
           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.StringgetPostalAddress()
voidsetPostalAddress(java.lang.String value)
           Barcode postal address.
java.lang.StringgetScalingFactor()
voidsetScalingFactor(java.lang.String value)
           Scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000].
java.lang.StringgetSymbolHeight()
voidsetSymbolHeight(java.lang.String value)
           Bar code image height (in twips - 1/1440 inches)
java.lang.StringgetSymbolRotation()
voidsetSymbolRotation(java.lang.String value)
           Rotation of the barcode symbol. Valid values are [0, 3].
 

Constructor Detail

BarcodeParameters

public BarcodeParameters()

Property Getters/Setters Detail

getAddStartStopChar/setAddStartStopChar

public boolean getAddStartStopChar() / public void setAddStartStopChar(boolean value)
Whether to add Start/Stop characters for barcode types NW7 and CODE39.

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getBackgroundColor/setBackgroundColor

public java.lang.String getBackgroundColor() / public void setBackgroundColor(java.lang.String value)
Bar code background color (0x000000 - 0xFFFFFF)

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getBarcodeType/setBarcodeType

public java.lang.String getBarcodeType() / public void setBarcodeType(java.lang.String value)
Bar code type.

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getBarcodeValue/setBarcodeValue

public java.lang.String getBarcodeValue() / public void setBarcodeValue(java.lang.String value)
Data to be encoded.

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getCaseCodeStyle/setCaseCodeStyle

public java.lang.String getCaseCodeStyle() / public void setCaseCodeStyle(java.lang.String value)
Style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD]

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getDisplayText/setDisplayText

public boolean getDisplayText() / public void setDisplayText(boolean value)
Whether to display barcode data (text) along with image.

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getErrorCorrectionLevel/setErrorCorrectionLevel

public java.lang.String getErrorCorrectionLevel() / public void setErrorCorrectionLevel(java.lang.String value)
Error correction level of QR Code. Valid values are [0, 3].

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getFacingIdentificationMark/setFacingIdentificationMark

public java.lang.String getFacingIdentificationMark() / public void setFacingIdentificationMark(java.lang.String value)
Type of a Facing Identification Mark (FIM).

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getFixCheckDigit/setFixCheckDigit

public boolean getFixCheckDigit() / public void setFixCheckDigit(boolean value)
Whether to fix the check digit if it’s invalid.

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getForegroundColor/setForegroundColor

public java.lang.String getForegroundColor() / public void setForegroundColor(java.lang.String value)
Bar code foreground color (0x000000 - 0xFFFFFF)

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

isBookmark/isBookmark

public boolean isBookmark() / public void isBookmark(boolean value)
Whether PostalAddress is the name of a bookmark.

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

isUSPostalAddress/isUSPostalAddress

public boolean isUSPostalAddress() / public void isUSPostalAddress(boolean value)
Whether PostalAddress is a U.S. postal address.

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getPosCodeStyle/setPosCodeStyle

public java.lang.String getPosCodeStyle() / public void setPosCodeStyle(java.lang.String value)
Style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). The valid values (case insensitive) are [STD|SUP2|SUP5|CASE].

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getPostalAddress/setPostalAddress

public java.lang.String getPostalAddress() / public void setPostalAddress(java.lang.String value)
Barcode postal address.

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getScalingFactor/setScalingFactor

public java.lang.String getScalingFactor() / public void setScalingFactor(java.lang.String value)
Scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000].

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getSymbolHeight/setSymbolHeight

public java.lang.String getSymbolHeight() / public void setSymbolHeight(java.lang.String value)
Bar code image height (in twips - 1/1440 inches)

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

getSymbolRotation/setSymbolRotation

public java.lang.String getSymbolRotation() / public void setSymbolRotation(java.lang.String value)
Rotation of the barcode symbol. Valid values are [0, 3].

Example:

Shows how to use a barcode generator.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We can use a custom IBarcodeGenerator implementation to generate barcodes,
// and then insert them into the document as images.
doc.getFieldOptions().setBarcodeGenerator(new CustomBarcodeGenerator());

// Below are four examples of different barcode types that we can create using our generator.
// For each barcode, we specify a new set of barcode parameters, and then generate the image.
// Afterwards, we can insert the image into the document, or save it to the local file system.
// 1 -  QR code:
BarcodeParameters barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("QR");
    barcodeParameters.setBarcodeValue("ABC123");
    barcodeParameters.setBackgroundColor("0xF8BD69");
    barcodeParameters.setForegroundColor("0xB5413B");
    barcodeParameters.setErrorCorrectionLevel("3");
    barcodeParameters.setScalingFactor("250");
    barcodeParameters.setSymbolHeight("1000");
    barcodeParameters.setSymbolRotation("0");
}

BufferedImage img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.QR.jpg"));

builder.insertImage(img);

// 2 -  EAN13 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("EAN13");
    barcodeParameters.setBarcodeValue("501234567890");
    barcodeParameters.setDisplayText(true);
    barcodeParameters.setPosCodeStyle("CASE");
    barcodeParameters.setFixCheckDigit(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.EAN13.jpg"));
builder.insertImage(img);

// 3 -  CODE39 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("CODE39");
    barcodeParameters.setBarcodeValue("12345ABCDE");
    barcodeParameters.setAddStartStopChar(true);
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.CODE39.jpg"));
builder.insertImage(img);

// 4 -  ITF14 barcode:
barcodeParameters = new BarcodeParameters();
{
    barcodeParameters.setBarcodeType("ITF14");
    barcodeParameters.setBarcodeValue("09312345678907");
    barcodeParameters.setCaseCodeStyle("STD");
}

img = doc.getFieldOptions().getBarcodeGenerator().getBarcodeImage(barcodeParameters);
ImageIO.write(img, "jpg", new File(getArtifactsDir() + "FieldOptions.BarcodeGenerator.ITF14.jpg"));
builder.insertImage(img);

doc.save(getArtifactsDir() + "FieldOptions.BarcodeGenerator.docx");

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.