Enum EncodeHintType

Namespace

ZXing

Assembly

zxing.dll

These are a set of hints that you may pass to Writers to specify their behavior.

public enum EncodeHintType

Fields

AZTEC_LAYERS = 18

Specifies the required number of layers for an Aztec code. A negative number (-1, -2, -3, -4) specifies a compact Aztec code 0 indicates to use the minimum number of layers (the default) A positive number (1, 2, .. 32) specifies a normal (non-compact) Aztec code type: int, or string representation of the integer value

CHARACTER_SET = 4

Specifies what character encoding to use where applicable. type: string

CODE128_COMPACT = 26

Specifies whether to use compact mode for Code-128 code (type {@link Boolean}, or "true" or "false" This can yield slightly smaller bar codes. This option and {@link #FORCE_CODE_SET} are mutually exclusive options.

CODE128_FORCE_CODESET_B = 16

if true, don't switch to codeset C for numbers

DATA_MATRIX_COMPACT = 25

Specifies whether to use compact mode for Data Matrix (type {@link Boolean}, or "true" or "false" The compact encoding mode also supports the encoding of characters that are not in the ISO-8859-1 character set via ECIs. Please note that in that case, the most compact character encoding is chosen for characters in the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by means of the {@link #CHARACTER_SET} encoding hint. Compact encoding also provides GS1-FNC1 support when {@link #GS1_FORMAT} is selected. In this case group-separator character (ASCII 29 decimal) can be used to encode the positions of FNC1 codewords for the purpose of delimiting AIs. This option and {@link #FORCE_C40} are mutually exclusive.

DATA_MATRIX_DEFAULT_ENCODATION = 17

Specifies the default encodation for Data Matrix (type Encodation) Make sure that the content fits into the encodation value, otherwise there will be an exception thrown. standard value: Encodation.ASCII

DATA_MATRIX_SHAPE = 13

Specifies the matrix shape for Data Matrix (type SymbolShapeHint)

DISABLE_ECI = 12

Don't append ECI segment. That is against the specification of QR Code but some readers have problems if the charset is switched from ISO-8859-1 (default) to UTF-8 with the necessary ECI segment. If you set the property to true you can use UTF-8 encoding and the ECI segment is omitted. type: bool

ERROR_CORRECTION = 3

Specifies what degree of error correction to use, for example in QR Codes. Type depends on the encoder. For example for QR codes it's type ErrorCorrectionLevel For Aztec it is of type int, representing the minimal percentage of error correction words. In all cases, it can also be a string representation of the desired value as well. Note: an Aztec symbol should have a minimum of 25% EC words. For PDF417 it is of type PDF417ErrorCorrectionLevel or int (between 0 and 8),

FORCE_C40 = 27

Forces C40 encoding for data-matrix (type {@link Boolean}, or "true" or "false") {@link String } value). This option and {@link #DATA_MATRIX_COMPACT} are mutually exclusive.

FORCE_CODE_SET = 22

Forces which encoding will be used. Currently only used for Code-128 code sets (Type string). Valid values are "A", "B", "C". see also CODE128_FORCE_CODESET_B This option and {@link #CODE128_COMPACT} are mutually exclusive.

GS1_FORMAT = 20

Specifies whether the data should be encoded to the GS1 standard type: bool, or "true" or "false" string value

HEIGHT = 1

Specifies the height of the barcode image type: int

MARGIN = 5

Specifies margin, in pixels, to use when generating the barcode. The meaning can vary by format; for example it controls margin before and after the barcode horizontally for most 1D formats. type: int, or string representation of the integer value

MAX_SIZE = 15

Specifies a maximum barcode size (type Dimension). Only applicable to Data Matrix now.

MIN_SIZE = 14

Specifies a minimum barcode size (type Dimension). Only applicable to Data Matrix now.

NO_PADDING = 24

if set to true, barcode writer uses WIDTH and HEIGHT as maximum values and in combination with MARGIN=0 there is no white border added. The resulting image would be smaller than the requested size.

PDF417_ASPECT_RATIO = 6

Specifies the aspect ratio to use. Default is 4. type: PDF417AspectRatio, or 1-4.

PDF417_AUTO_ECI = 28

Specifies whether to automatically insert ECIs when encoding PDF417 (type {@link Boolean}, or "true" or "false" {@link String} value). Please note that in that case, the most compact character encoding is chosen for characters in the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by means of the {@link #CHARACTER_SET} encoding hint.

PDF417_COMPACT = 8

Specifies whether to use compact mode for PDF417 type: bool, or "true" or "false" string value

PDF417_COMPACTION = 9

Specifies what compaction mode to use for PDF417. type: Compaction or string value of one of its enum values

PDF417_DIMENSIONS = 10

Specifies the minimum and maximum number of rows and columns for PDF417. type: Dimensions

PDF417_IMAGE_ASPECT_RATIO = 7

Specifies the desired aspect ratio (number of columns / number of rows) of the output image. Default is 3. type: float.

PDF417_MACRO_META_DATA = 11

The Specifies that the PDF417 will contain macro metadata. type: PDF417MacroMetadata

PURE_BARCODE = 2

Don't put the content string into the output image. type: bool

QR_COMPACT = 23

Specifies whether to use compact mode for QR code (type bool, or "true" or "false" Please note that when compaction is performed, the most compact character encoding is chosen for characters in the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by means of the CHARACTER_SET encoding hint.

QR_MASK_PATTERN = 21

Specifies the QR code mask pattern to be used. Allowed values are 0..QRCode.NUM_MASK_PATTERNS-1. By default the code will automatically select the optimal mask pattern. (Type int, or string representation of the integer value).

QR_VERSION = 19

Specifies the exact version of QR code to be encoded. (Type int, or string representation of the integer value).

WIDTH = 0

Specifies the width of the barcode image type: int