BX_CreateParameters

Specifies the parameters used when creating a barcode.

Declaration:

	Copy Code
typedef struct tagBX_CreateParameters { long ParametersVersion; const char* Value; long ValueLength; BX_BarcodeType BarcodeType; long Width; long Height; long MinimumBarWidth; long MinimumBarHeight; long VerticalWhiteSpace; _Bool AdjustBarWidth; _Bool AutoSize; BX_CreateParameters1D Params1D; BX_CreateParameters2D Params2D; } BX_CreateParameters;

Copy Code

typedef struct tagBX_CreateParameters {
    long ParametersVersion;
    const char* Value;
    long ValueLength;
    BX_BarcodeType BarcodeType;
    long Width;
    long Height;
    long MinimumBarWidth;
    long MinimumBarHeight;
    long VerticalWhiteSpace;
    _Bool AdjustBarWidth;
    _Bool AutoSize;
    BX_CreateParameters1D Params1D;
    BX_CreateParameters2D Params2D;
} BX_CreateParameters;

Members:

ParametersVersion	long	Specifies the version of the create parameters structure. The only valid value is 1. Do not change this to any other value.
Value	const char*	Specifies the value of the barcode to create. The default value is an empty string "".
ValueLength	long	Specifies the length of the Value string.
BarcodeType	BX_BarcodeType	Specifies the type of barcode to create.
Width	long	Specifies the width of the image, in pixels, containing the barcode. If AutoSize is true, then this value is ignored. The default value is 600.
Height	long	Specifies the height of the image, in pixels, containing the barcode. If AutoSize is true, then this value is ignored. The default value is 600.
MinimumBarWidth	long	Specifies the minimum bar width when creating a barcode. The default value is 3. This value is used to set the bar width in 1D and PDF417 barcodes and the module size (black and white squares that make up the barcode) in Data Matrix barcodes. If AdjustBarWidth parameter is set to true then this value is ignored.
MinimumBarHeight	long	Specifies the minimum height of the bars when creating a barcode. The default value is 100 (PDF417 should set this value between 3 and 5). This value is used to set the bar height in 1D barcodes. PDF417 uses this value as a multiplier of the minimum barcode width to set the module height of each data row. This property does not affect Data Matrix.
HorizontalWhiteSpace	long	Specifies the amount of white space that is created on the sides of the barcode. The default value is 50. The white space surrounding the barcode is also known as the quiet zone. Many barcode readers/specifications require a quiet zone for accurate detection.
VerticalWhiteSpace	long	Specifies the amount of white space that is created above and below the barcode. The default value is 50. The white space surrounding the barcode is also known as the quiet zone. Many barcode readers/specifications require a quiet zone for accurate detection.
AdjustBarWidth	_Bool	Specifies if dynamic adjustment of the bar widths during barcode creation is allowed. The default value is true.
AutoSize	_Bool	Specifies if the barcode area is automatically sized during barcode creation. The default value is true. When this property is set to true, the component will calculate the required height and width of the output image during barcode creation. The image height and width are calculated using the barcode value, minimum bar width, horizontal gaps, vertical gaps and the size of the text font. If the calculated height or width is greater than the user input height and width, the image size will be increased to create the barcode. When this property is set to false, the component will use the "Height" and "Width" parameters.
Params1D	BX_CreateParameters1D	Specifies the parameters for creating a 1D barcode. This value is used when the BarcodeType is set to a 1D barcode. If creating a 2D barcode then this value is ignored.
Params2D	BX_CreateParameters2D	Specifies the parameters for creating a 2D barcode. This value is used when the BarcodeType is set to a 2D barcode. If creating a 1D barcode then this value is ignored.