QRCodeGS1OptionsBuilder Class
Builds a QRCodeGS1Options object. Chain builder methods to configure barcode settings, then call the build() method to create the options object.
Declaration
public class QRCodeGS1OptionsBuilder extends BarcodeOptionsBuilder<QRCodeGS1Options,QRCodeGS1OptionsBuilder>Remarks
Refer to the following help topic for additional information: GS1 QR Code.
The following code snippet creates a GS1 QR Code 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 {
QRCodeGS1Options options = QRCodeGS1OptionsBuilder.create()
.withErrorCorrectionLevel(QRCodeErrorCorrectionLevel.H)
.withCompactionMode(QRCodeCompactionMode.AUTO)
.withIncludeQuietZone(true)
.withVersion(QRCodeVersion.VERSION_20)
.withModuleSize(50)
.withPadding(new Padding(10))
.withShowText(false)
.withWidth(600)
.build();
Path outputDir = Path.of("output");
Files.createDirectories(outputDir);
try (FileOutputStream fileStream = new FileOutputStream(
outputDir.resolve("qrcodeGS1.png").toFile());
BarcodeGenerator barcodeGenerator = new BarcodeGenerator(options)) {
barcodeGenerator.export(
"(01)09506000134352(17)260630(2026)https://www.devexpress.com",
fileStream,
DXImageFormat.getPng());
}
}
}
Inherited Members
Inheritance
QRCodeGS1OptionsBuilder()
Initializes a new instance of the QRCodeGS1OptionsBuilder class.
Declaration
public QRCodeGS1OptionsBuilder()Methods
create() Method
Creates a new QRCodeGS1OptionsBuilder instance.
Declaration
public static QRCodeGS1OptionsBuilder create()Returns
| Type | Description |
|---|---|
QRCodeGS1OptionsBuilder |
The current |
withCompactionMode(QRCodeCompactionMode mode) Method
Specifies the compaction mode and returns the builder instance for method chaining.
Declaration
public QRCodeGS1OptionsBuilder withCompactionMode(QRCodeCompactionMode mode)Parameters
| Name | Type | Description |
|---|---|---|
| mode | QRCodeCompactionMode | Indicates the compaction mode. |
Returns
| Type | Description |
|---|---|
QRCodeGS1OptionsBuilder |
The builder instance for method chaining. |
withErrorCorrectionLevel(QRCodeErrorCorrectionLevel correctionLevel) Method
Specifies the error correction level. Returns the builder instance for method chaining.
Declaration
public QRCodeGS1OptionsBuilder withErrorCorrectionLevel(QRCodeErrorCorrectionLevel correctionLevel)Parameters
| Name | Type | Description |
|---|---|---|
| correctionLevel | QRCodeErrorCorrectionLevel | Indicates the error correction level. |
Returns
| Type | Description |
|---|---|
QRCodeGS1OptionsBuilder |
The builder instance for method chaining. |
withFNC1Substitute(String substitute) Method
Specifies a substring/character that serves as the placeholder for the FNC1 functional character. Returns the builder instance for method chaining.
Declaration
public QRCodeGS1OptionsBuilder withFNC1Substitute(String substitute)Parameters
| Name | Type | Description |
|---|---|---|
| substitute | String | The symbols to be replaced. |
Returns
| Type | Description |
|---|---|
QRCodeGS1OptionsBuilder |
The builder instance for method chaining. |
withFrameOptions(QRFrameOptions options) Method
Specifies the frame options. Returns the builder instance for method chaining.
Declaration
public QRCodeGS1OptionsBuilder withFrameOptions(QRFrameOptions options)Parameters
| Name | Type | Description |
|---|---|---|
| options | QRFrameOptions | An object that specifies frame options. |
Returns
| Type | Description |
|---|---|
QRCodeGS1OptionsBuilder |
The builder instance for method chaining. |
withIncludeQuietZone(boolean includeQuietZone) Method
Specifies whether to include a quiet zone around code. Returns the builder instance for method chaining.
Declaration
public QRCodeGS1OptionsBuilder withIncludeQuietZone(boolean includeQuietZone)Parameters
| Name | Type | Description |
|---|---|---|
| includeQuietZone | boolean |
|
Returns
| Type | Description |
|---|---|
QRCodeGS1OptionsBuilder |
The builder instance for method chaining. |
withLogo(DXImage logo) Method
Specifies a logo image. Returns the builder instance for method chaining.
Declaration
public QRCodeGS1OptionsBuilder withLogo(DXImage logo)Parameters
| Name | Type | Description |
|---|---|---|
| logo | DXImage | Logo image. |
Returns
| Type | Description |
|---|---|
QRCodeGS1OptionsBuilder |
The builder instance for method chaining. |
withVersion(QRCodeVersion version) Method
Specifies the code version and returns the builder instance for method chaining.
Declaration
public QRCodeGS1OptionsBuilder withVersion(QRCodeVersion version)Parameters
| Name | Type | Description |
|---|---|---|
| version | QRCodeVersion | Indicates the code version. |
Returns
| Type | Description |
|---|---|
QRCodeGS1OptionsBuilder |
The builder instance for method chaining. |