Code128OptionsBuilder Class

Builds an Code128Options object. Use chained builder methods to configure barcode settings, then call the build() method to create the options object.

Declaration

public class Code128OptionsBuilder extends BarcodeOptionsBuilder<Code128Options,Code128OptionsBuilder>

Remarks

Refer to the following help topic for additional information: Code 128.

The following code snippet creates a Code 128 barcode and customizes its encoding parameters with the Fluent API:

import com.devexpress.drawing.*;
import com.devexpress.docs.barcode.*;
import com.devexpress.system.drawing.*;
import com.devexpress.docs.Padding;

import java.io.*;
import java.nio.file.*;

public class Main {
    public static void main(String[] args) throws Exception {

        Code128Options options =  Code128OptionsBuilder.create()
            .withCharset(Code128CharacterSet.CHARSET_B)
            .withAddLeadingZero(true)
            .withFNC1Substitute("<FNC1>")
            .withFNC2Substitute("<FNC2>")
            .withFNC3Substitute("<FNC3>")
            .withShowText(true)
            .build();


        Path outputDir = Path.of("output");
        Files.createDirectories(outputDir);

        try (FileOutputStream fileStream = new FileOutputStream(
                outputDir.resolve("code128.png").toFile());
                BarcodeGenerator barcodeGenerator = new BarcodeGenerator(options)) {
                    barcodeGenerator.export(
                            "ORD-4589-US-25A",
                            fileStream,
                            DXImageFormat.getPng());
        }
    }
}

Inherited Members

build()

withBackColor(Color backColor)

withBarHeight(float barHeight)

withBorderColor(Color borderColor)

withBorderDashStyle(BorderDashStyle borderDashStyle)

withBorderStyle(BorderStyle borderStyle)

withBorderWidth(float borderWidth)

withCodeTextHorizontalAlignment(DXStringAlignment alignment)

withCodeTextVerticalAlignment(DXStringAlignment alignment)

withDpi(float dpi)

withFooter(BarcodeLabel footer)

withFooter(String text)

withForeColor(Color foreColor)

withHeader(BarcodeLabel header)

withHeader(String text)

withHeight(float height)

withMargin(Padding margin)

withMargin(int all)

withMargin(int left, int top, int right, int bottom)

withModuleSize(float moduleSize)

withPadding(Padding padding)

withPadding(int all)

withPadding(int left, int top, int right, int bottom)

withRightToLeft(boolean rightToLeft)

withRotationAngle(float rotationAngle)

withShowText(boolean showText)

withSides(BorderSide sides)

withSize(SizeF size)

withSize(float width, float height)

withSizeMode(SizeMode sizeMode)

withTextFont(DXFont textFont)

withTextRenderingHint(DXTextRenderingHint textRenderingHint)

withUnit(DXGraphicsUnit unit)

withWidth(float width)

withWordWrap(boolean wordWrap)

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.initFields()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

JavaObject

BarcodeOptionsBuilder<TOptions,TBuilder>

Code128OptionsBuilder

Code128OptionsBuilder()

Initializes a new instance of the Code128OptionsBuilder class.

Declaration

public Code128OptionsBuilder()

Methods

create() Method

Creates a Code128OptionsBuilder instance.

Declaration

public static Code128OptionsBuilder create()

Returns

Type	Description
Code128OptionsBuilder	The current Code128OptionsBuilder instance for method chaining.

withAddLeadingZero(boolean addLeadingZero) Method

Specifies whether to prepend a leading zero when encoding numeric data in Code Set C (CHARSET_C). Returns a builder instance for method chaining.

Declaration

public Code128OptionsBuilder withAddLeadingZero(boolean addLeadingZero)

Parameters

Name	Type	Description
addLeadingZero	boolean	true to prepend a leading zero; otherwise, false.

Returns

Type	Description
Code128OptionsBuilder	The current Code128OptionsBuilder instance for method chaining.

withCharset(Code128CharacterSet charset) Method

Specifies the character set used to encode data in Code 128 barcode and returns a builder instance for method chaining.

Declaration

public Code128OptionsBuilder withCharset(Code128CharacterSet charset)

Parameters

Name	Type	Description
charset	Code128CharacterSet	The used charset.

Returns

Type	Description
Code128OptionsBuilder	The current Code128OptionsBuilder instance for method chaining.

withFNC1Substitute(String substitute) Method

Specifies a substring/character that serves as the placeholder for the FNC1 functional character. Returns a builder instance for method chaining.

Declaration

public Code128OptionsBuilder withFNC1Substitute(String substitute)

Parameters

Name	Type	Description
substitute	String	Symbols to be replaced.

Returns

Type	Description
Code128OptionsBuilder	The current Code128OptionsBuilder instance for method chaining.

withFNC2Substitute(String substitute) Method

Specifies a substring/character that serves as the placeholder for the FNC2 functional character. Returns a builder instance for method chaining.

Declaration

public Code128OptionsBuilder withFNC2Substitute(String substitute)

Parameters

Name	Type	Description
substitute	String	Symbols to be replaced.

Returns

Type	Description
Code128OptionsBuilder	The current Code128OptionsBuilder instance for method chaining.

withFNC3Substitute(String substitute) Method

Specifies a substring/character that serves as the placeholder for the FNC3 functional character. Returns a builder instance for method chaining.

Declaration

public Code128OptionsBuilder withFNC3Substitute(String substitute)

Parameters

Name	Type	Description
substitute	String	Symbols to be replaced.

Returns

Type	Description
Code128OptionsBuilder	The current Code128OptionsBuilder instance for method chaining.

withFNC4Substitute(String substitute) Method

Specifies a substring/character that serves as the placeholder for the FNC4 functional character. Returns a builder instance for method chaining.

Declaration

public Code128OptionsBuilder withFNC4Substitute(String substitute)

Parameters

Name	Type	Description
substitute	String	Symbols to be replaced.

Returns

Type	Description
Code128OptionsBuilder	The current Code128OptionsBuilder instance for method chaining.