| typeOfBarcode |
EncodeBarcodeType |
Type of barcode to generate. |
|
| text |
String |
Text to encode. |
|
| twoDDisplayText |
String |
Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode |
[optional] |
| textLocation |
CodeLocation |
Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below. |
[optional] |
| textAlignment |
TextAlignment |
Text alignment. |
[optional] |
| textColor |
String |
Specify the displaying CodeText's Color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF |
[optional] |
| font |
FontParams |
Specify the displaying Text's font. Default value: Arial 5pt regular. Ignored if FontSizeMode is set to FontSizeMode.Auto. |
[optional] |
| fontSizeMode |
FontMode |
Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto. |
[optional] |
| noWrap |
Boolean |
Specify word wraps (line breaks) within text. Default value: false. |
[optional] |
| resolution |
Double |
Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. |
[optional] |
| resolutionX |
Double |
DEPRECATED: Use 'Resolution' instead. |
[optional] |
| resolutionY |
Double |
DEPRECATED: Use 'Resolution' instead. |
[optional] |
| dimensionX |
Double |
The smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation. |
[optional] |
| textSpace |
Double |
Space between the CodeText and the BarCode in Unit value. Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon. |
[optional] |
| units |
AvailableGraphicsUnit |
Common Units for all measuring in query. Default units: pixel. |
[optional] |
| sizeMode |
AutoSizeMode |
Specifies the different types of automatic sizing modes. Default value: AutoSizeMode.None. |
[optional] |
| barHeight |
Double |
Height of the barcode in given units. Default units: pixel. |
[optional] |
| imageHeight |
Double |
Height of the barcode image in given units. Default units: pixel. |
[optional] |
| imageWidth |
Double |
Width of the barcode image in given units. Default units: pixel. |
[optional] |
| rotationAngle |
Double |
BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. |
[optional] |
| padding |
Padding |
Barcode paddings. Default value: 5pt 5pt 5pt 5pt. |
[optional] |
| captionAbove |
CaptionParams |
Additional caption above barcode. |
[optional] |
| captionBelow |
CaptionParams |
Additional caption below barcode. |
[optional] |
| backColor |
String |
Background color of the barcode image. Default value: white. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF |
[optional] |
| barColor |
String |
Bars color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF |
[optional] |
| borderColor |
String |
Border color. Default value: black. Use named colors like: red, green, blue Or HTML colors like: #FF0000, #00FF00, #0000FF |
[optional] |
| borderWidth |
Double |
Border width. Default value: 0. Ignored if Visible is set to false. |
[optional] |
| borderDashStyle |
BorderDashStyle |
Border dash style. Default value: BorderDashStyle.Solid. |
[optional] |
| borderVisible |
Boolean |
Border visibility. If false than parameter Width is always ignored (0). Default value: false. |
[optional] |
| enableChecksum |
EnableChecksum |
Enable checksum during generation 1D barcodes. Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible. Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar Checksum always used: Rest symbology |
[optional] |
| enableEscape |
Boolean |
Indicates whether explains the character "\" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only If the EnableEscape is true, "\" will be explained as a special escape character. Otherwise, "\" acts as normal characters. Aspose.BarCode supports input decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \\CR stands for CR. |
[optional] |
| filledBars |
Boolean |
Value indicating whether bars are filled. Only for 1D barcodes. Default value: true. |
[optional] |
| alwaysShowChecksum |
Boolean |
Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes. |
[optional] |
| wideNarrowRatio |
Double |
Wide bars to Narrow bars ratio. Default value: 3, that is, wide bars are 3 times as wide as narrow bars. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard |
[optional] |
| validateText |
Boolean |
Only for 1D barcodes. If codetext is incorrect and value set to true - exception will be thrown. Otherwise codetext will be corrected to match barcode's specification. Exception always will be thrown for: Databar symbology if codetext is incorrect. Exception always will not be thrown for: AustraliaPost, SingaporePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect. |
[optional] |
| supplementData |
String |
Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN. |
[optional] |
| supplementSpace |
Double |
Space between main the BarCode and supplement BarCode. |
[optional] |
| barWidthReduction |
Double |
Bars reduction value that is used to compensate ink spread while printing. |
[optional] |
| useAntiAlias |
Boolean |
Indicates whether is used anti-aliasing mode to render image. Anti-aliasing mode is applied to barcode and text drawing. |
[optional] |
| australianPost |
AustralianPostParams |
AustralianPost params. |
[optional] |
| aztec |
AztecParams |
Aztec params. |
[optional] |
| codabar |
CodabarParams |
Codabar params. |
[optional] |
| codablock |
CodablockParams |
Codablock params. |
[optional] |
| code16K |
Code16KParams |
Code16K params. |
[optional] |
| coupon |
CouponParams |
Coupon params. |
[optional] |
| dataBar |
DataBarParams |
DataBar params. |
[optional] |
| dataMatrix |
DataMatrixParams |
DataMatrix params. |
[optional] |
| dotCode |
DotCodeParams |
DotCode params. |
[optional] |
| ITF |
ITFParams |
ITF params. |
[optional] |
| maxiCode |
MaxiCodeParams |
MaxiCode params. |
[optional] |
| pdf417 |
Pdf417Params |
Pdf417 params. |
[optional] |
| postal |
PostalParams |
Postal params. |
[optional] |
| QR |
QrParams |
QR params. |
[optional] |
| patchCode |
PatchCodeParams |
PatchCode params. |
[optional] |
| code128 |
Code128Params |
Code128 parameters |
[optional] |
| hanXin |
HanXinParams |
HanXin params. |
[optional] |