Package com.aspose.barcode.generation

Class BarcodeParameters

java.lang.Object
com.aspose.barcode.generation.BarcodeParameters
public class BarcodeParameters extends Object

Barcode generation parameters.

  • Method Details

    • getBarcodeType

      public final BaseEncodeType getBarcodeType()

    • getCodeText

      public final String getCodeText()

    • setCodeText

      public final void setCodeText(String value)

    • getXDimension

      public final Unit getXDimension()

      x-dimension is the smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if BaseGenerationParameters.AutoSizeMode(BaseGenerationParameters.getAutoSizeMode()/BaseGenerationParameters.setAutoSizeMode(com.aspose.barcode.generation.AutoSizeMode)) property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation.

    • setXDimension

      public final void setXDimension(Unit value)

      x-dimension is the smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if BaseGenerationParameters.AutoSizeMode(BaseGenerationParameters.getAutoSizeMode()/BaseGenerationParameters.setAutoSizeMode(com.aspose.barcode.generation.AutoSizeMode)) property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation.

    • getBarHeight

      public final Unit getBarHeight()

      Height of 1D barcodes' bars in Unit value. Ignored if BaseGenerationParameters.AutoSizeMode(BaseGenerationParameters.getAutoSizeMode()/BaseGenerationParameters.setAutoSizeMode(com.aspose.barcode.generation.AutoSizeMode)) property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation.

    • setBarHeight

      public final void setBarHeight(Unit value)

      Height of 1D barcodes' bars in Unit value. Ignored if BaseGenerationParameters.AutoSizeMode(BaseGenerationParameters.getAutoSizeMode()/BaseGenerationParameters.setAutoSizeMode(com.aspose.barcode.generation.AutoSizeMode)) property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation.

    • getBarColor

      public final int getBarColor()

      Bars color. Default value: Color.Black.

    • setBarColor

      public final void setBarColor(int value)

      Bars color. Default value: Color.Black.

    • getPadding

      public final Padding getPadding()

      Barcode paddings. Default value: 5pt 5pt 5pt 5pt.

    • getChecksumAlwaysShow

      public final boolean getChecksumAlwaysShow()

      Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.

    • setChecksumAlwaysShow

      public final void setChecksumAlwaysShow(boolean value)

      Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.

    • isChecksumEnabled

      public final EnableChecksum isChecksumEnabled()

      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

    • setChecksumEnabled

      public final void setChecksumEnabled(EnableChecksum value)

      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

    • getEnableEscape

      public final boolean getEnableEscape()
      Deprecated.
      "EnableEscape is deprecated and ignored. Process escape sequences explicitly (e.g., Regex.Unescape). This property will be removed in future releases."

      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 inputing decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \\CR stands for CR.

    • setEnableEscape

      public final void setEnableEscape(boolean value)

      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 inputing decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \\CR stands for CR.

    • getThrowExceptionWhenCodeTextIncorrect

      public final boolean getThrowExceptionWhenCodeTextIncorrect()

      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, SingapurePost, Code39FullASCII, Code93, Code16K, Code128 symbology if codetext is incorrect.

    • setThrowExceptionWhenCodeTextIncorrect

      public final void setThrowExceptionWhenCodeTextIncorrect(boolean value)

      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, SingapurePost, Code39FullASCII, Code93, Code16K, Code128 symbology if codetext is incorrect.

    • getWideNarrowRatio

      public final float getWideNarrowRatio()

      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, Code39, Code39FullASCII

      Throws:
      IllegalArgumentException - <p>The <b>WideNarrowRatio</b> parameter value is less than or equal to 0.</p>

    • setWideNarrowRatio

      public final void setWideNarrowRatio(float value)

      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, Code39, Code39FullASCII

      Throws:
      IllegalArgumentException - <p>The <b>WideNarrowRatio</b> parameter value is less than or equal to 0.</p>

    • getCodeTextParameters

      public final CodetextParameters getCodeTextParameters()

      Codetext parameters.

    • getFilledBars

      public final boolean getFilledBars()

      Gets a value indicating whether bars filled. Only for 1D barcodes. Default value: true.

      Returns:
      a value indicating whether bars filled.

    • setFilledBars

      public final void setFilledBars(boolean value)

      Sets a value indicating whether bars filled. Only for 1D barcodes. Default value: true.

      Parameters:
      value - a value indicating whether bars filled.

    • getBarWidthReduction

      public final Unit getBarWidthReduction()

      Get bars reduction value that is used to compensate ink spread while printing. Default value: 0

      Returns:
      bars reduction value that is used to compensate ink spread while printing.

    • setBarWidthReduction

      public final void setBarWidthReduction(Unit value)

      Sets bars reduction value that is used to compensate ink spread while printing. Default value: 0

      Parameters:
      value - bars reduction value that is used to compensate ink spread while printing.

    • getPostal

      public final PostalParameters getPostal()

      Postal parameters. Used for Postnet, Planet.

    • getPatchCode

      public final PatchCodeParameters getPatchCode()

      PatchCode parameters.

    • getAustralianPost

      public final AustralianPostParameters getAustralianPost()

      AustralianPost barcode parameters.

    • getDataBar

      public final DataBarParameters getDataBar()

      Databar parameters.

    • getGS1CompositeBar

      public final GS1CompositeBarParameters getGS1CompositeBar()

      GS1 Composite Bar parameters.

      This sample shows how to create and save a GS1 Composite Bar image. Note that 1D codetext and 2D codetext are separated by symbol '|' 

      
 [C#]
   var codetext = "(01)03212345678906|(21)A1B2C3D4E5F6G7H8";
 	  using (var generator = new BarcodeGenerator(EncodeTypes.GS1CompositeBar, codetext))
 	  {
       generator.Parameters.Barcode.GS1CompositeBar.LinearComponentType = EncodeTypes.GS1Code128;
       generator.Parameters.Barcode.GS1CompositeBar.TwoDComponentType = TwoDComponentType.CC_A;
       // Aspect ratio of 2D component
       generator.Parameters.Barcode.Pdf417.AspectRatio = 3;
       // X-Dimension of 1D and 2D components
       generator.Parameters.Barcode.XDimension.Pixels = 3;
       // Height of 1D component
       generator.Parameters.Barcode.BarHeight.Pixels = 100;
       generator.Save("test.png");
   }

    • setGS1CompositeBar

      public final void setGS1CompositeBar(GS1CompositeBarParameters value)

      GS1 Composite Bar parameters.

      This sample shows how to create and save a GS1 Composite Bar image. Note that 1D codetext and 2D codetext are separated by symbol '|' 

      
 [C#]
   var codetext = "(01)03212345678906|(21)A1B2C3D4E5F6G7H8";
 	  using (var generator = new BarcodeGenerator(EncodeTypes.GS1CompositeBar, codetext))
 	  {
       generator.Parameters.Barcode.GS1CompositeBar.LinearComponentType = EncodeTypes.GS1Code128;
       generator.Parameters.Barcode.GS1CompositeBar.TwoDComponentType = TwoDComponentType.CC_A;
       // Aspect ratio of 2D component
       generator.Parameters.Barcode.Pdf417.AspectRatio = 3;
       // X-Dimension of 1D and 2D components
       generator.Parameters.Barcode.XDimension.Pixels = 3;
       // Height of 1D component
       generator.Parameters.Barcode.BarHeight.Pixels = 100;
       generator.Save("test.png");
   }

    • getCodablock

      public final CodablockParameters getCodablock()

      Codablock parameters.

    • getDataMatrix

      public final DataMatrixParameters getDataMatrix()

      DataMatrix parameters.

    • getCode16K

      public final Code16KParameters getCode16K()

      Code16K parameters.

    • getDotCode

      public final DotCodeParameters getDotCode()

      DotCode parameters.

    • getITF

      public final ITFParameters getITF()

      ITF parameters.

    • getPdf417

      public final Pdf417Parameters getPdf417()

      PDF417 parameters.

    • getQR

      public final QrParameters getQR()

      QR, MicroQR and RectMicroQR parameters.

    • getSupplement

      public final SupplementParameters getSupplement()

      Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.

    • getMaxiCode

      public final MaxiCodeParameters getMaxiCode()

      MaxiCode parameters.

    • getAztec

      public final AztecParameters getAztec()

      Aztec parameters.

    • getCode128

      public final Code128Parameters getCode128()

      Code128 parameters.

    • getCodabar

      public final CodabarParameters getCodabar()

      Codabar parameters.

    • getCoupon

      public final CouponParameters getCoupon()

      Coupon parameters. Used for UpcaGs1DatabarCoupon, UpcaGs1Code128Coupon.

    • getHanXin

      public final HanXinParameters getHanXin()

      HanXin parameters.

    • getComplexBarcode

      public final ComplexBarcode getComplexBarcode()

    • getAspectRatio

      public final float getAspectRatio()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object