BarcodeCreator

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.spire.barcode.implementation.generator.generation
Class BarcodeCreator

java.lang.Object
  com.spire.barcode.implementation.generator.generation.BarcodeCreator

public class BarcodeCreator
extends java.lang.Object
extends java.lang.Object

BarcodeGenerator for backend Barcode images generation.

supported symbology: 1D: Codabar, Code11, Code128, Code39Standard, Code39Extended Code93Standard, Code93Extended, EAN13, EAN8, Interleaved2of5, MSI, Standard2of5, UPCA, UPCE, BooklandEAN, EAN128, Postnet, Planet EAN14, SCC14, SSCC18, ITF14, SingaporePost 2D: DataMatrix, PDf417, QR code

Constructor Summary
`BarcodeCreator()` BarcodeGenerator's constructer, default SymbologyType is Code128, default CodeText is 12345678
`BarcodeCreator(java.lang.String CodeText)` BarcodeGenerator's constructer, default SymbologyType is Code128
`BarcodeCreator(java.lang.String CodeText, SymbologyType type)` BarcodeGenerator's constructer

Method Summary
`void`	`dispose()` Deprecated.
`com.spire.ms.System.Drawing.Bitmap`	`generateBarcodeImage()` Generate the Barcode image under current settings
`boolean`	`getAlwaysShowChecksum()` Always display checksum digit in the humanreadable text for Code128 and EAN128 Barcodes.
`float`	`getAspectRatio()` 2D Barcode's module's height/width ratio (yDimension/xDimension).
`AustraliaPostFormatControlCode`	`getAustraliaPostFormatControlCode()` Australia Post symbology type of Barcode's FormatControlCode, default to AustraliaPostFormatControlCode.Standard" See AustraliaPostFormatControlCode.
`boolean`	`getAutoSize()` Wether ajust image's size automatically.
`int`	`getAztectErrorLevel()` Level of error corection of Aztect types of Barcode.
`com.spire.ms.System.Drawing.Color`	`getBackColor()` Background color of the Barcode image See Color.
`com.spire.ms.System.Drawing.Bitmap`	`getBarcodeImage()`
`CodeCaption`	`getBarcodeImageCodeCaptionAbove()`
`float`	`getBarHeight()` height of 1D Barcodes' bars.
`com.spire.ms.System.Drawing.Color`	`getBorderColor()` Barcode Image's border's color See Color.
`BorderDashStyle`	`getBorderDashStyle()` Barcode Image's border's style See BorderDashStyle.
`boolean`	`getBorderVisible()` whether Barcode Image's border is visible See `BarcodeCreator.getBorderWidth()`.
`float`	`getBorderWidth()` Barcode Image's border's width Default Graphics Unit: Millimeter See `BarcodeCreator.getBorderVisible()`.
`CodabarChar`	`getCodabarStartSymbol()` Start symbol (character) of codabar symbology See `BarcodeCreator.getCodabarStopSymbol()`.
`CodabarChar`	`getCodabarStopSymbol()` Stop symbol (character) of codabar symbology See `BarcodeCreator.getCodabarStartSymbol()`.
`Code128SetMode`	`getCode128CodeSet()`
`CodeCaption`	`getCodeCaptionAbove()` CodeCaption Above the Barcode image.
`CodeCaption`	`getCodeCaptionBelow()` CodeCaption Below the Barcode image.
`CodeCaption`	`getCodeCaptionLogoImage()`
`java.lang.String`	`getCodeText()` Data to be encoded, different types of Barcode may have different CodeText length restrictions See `BarcodeCreator.getEnableEscape()`.
`StringAlignment`	`getCodeTextAlignment()` Gets the alignment of the code text.
`com.spire.ms.System.Drawing.Color`	`getCodeTextColor()` Specify the displaying CodeText's Color See `BarcodeCreator.getCodeText()`.
`com.spire.ms.System.Text.Encoding`	`getCodeTextEncoding()` Gets the encoding of codetext.
`com.spire.ms.System.Drawing.Font`	`getCodeTextFont()` Specify the displaying CodeText's font See `BarcodeCreator.getCodeText()` .
`float`	`getCodeTextSpace()` Space between the CodeText and the Barcode.
`int`	`getColumns()` 2D Barcode's columns, if setting is illegal then columns will be calculated automatically appliable SymbologyType: Pdf417
`com.spire.ms.System.Drawing.Bitmap`	`getCustomSizeBarCodeImage(com.spire.ms.System.Drawing.Size customBarCodeSize, boolean allowSpaceAround)` Gets the scaled barcode image.
`DataMatrixEncodeMode`	`getDataMatrixEncodeMode()` Encode mode of Datamatrix Barcode, default to Auto `DataMatrixEncodeMode`.
`java.lang.String`	`getDisplay2DText()` Gets the text will displayed on the Barcode's image.
`EAN128EncodeMode`	`getEAN128EncodeMode()`
`EnableChecksum`	`getEnableChecksum()` Enable checksum during generation for 1D Barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies
`boolean`	`getEnableEscape()` Indicates whether explains the character "\" as an escape character in CodeText property.
`com.spire.ms.System.Drawing.Color`	`getForeColor()` Foreground color of the Barcode image, that is, Bar's color of 1D Barcode, Module's color of 2D Barcode See Color.
`GraphicsUnit`	`getGraphicsUnit()` Measurement of various properties such as Width, Height etc.
`float`	`getImageHeight()` Barcode image's height See `BarcodeCreator.getAutoSize()`., if AutoSize is true, ImageHeight will be increased accordingly Default Graphics Unit: Millimeter
`ImageQualityMode`	`getImageQuality()` Graphics quality mode, when RotationAngleF not equal to 0, 90, 180 or 270, do set quality mode to anti-alias.
`float`	`getImageWidth()` Barcode image's width See `BarcodeCreator.getAutoSize()`, if AutoSize is true, ImageWidth will be increased accordingly Default Graphics Unit: Millimeter
`ITF14BorderType`	`getITF14BorderType()` Border type of ITF14 Barcode, quiet zone will be determined by margin settings.
`int`	`getMacroPdf417FileID()` Gets macro pdf417 Barcode's file ID.
`int`	`getMacroPdf417SegmentID()` Gets macro pdf417 Barcode's segment ID, which starts from 0, to MacroPdf417SegmentCount - 1.
`int`	`getMacroPdf417SegmentsCount()` Gets whether this macro pdf417 Barcode is the last segment.
`MarginsF`	`getMargins()` Margin area around the core Barcode image If AutoSize is false, then Width and Height is fixed, thus Margins setting will be ignored Default Graphics Unit: Millimeter
`Pdf417DataMode`	`getPdf417CompactionMode()` Pdf417 symbology type of Barcode's compaction mode, default compaction mode is Auto See Pdf417DataMode.
`Pdf417ECL`	`getPdf417ErrorLevel()` Gets Pdf417 symbology type of Barcode's error coccrection level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture
`boolean`	`getPdf417Truncate()` whether pdf417 symbology type of Barcode is truncated (to reduce space)
`float`	`getPlanetShortBarHeight()` Short bar's height of Planet Barcode, it has to be between 1 millimeter and 1.5 milimeters.
`float`	`getPostnetShortBarHeight()` Short bar's height of Postnet Barcode, it has to be between 1 millimeter and 1.5 milimeter (0.04 inch and 0.06 inch).
`java.lang.String`	`getPrinterName()` Choose printer, if not specified, Print() method will choose the first available printer
`QRCodeDataMode`	`getQREncodeMode()` QR symbology type of Barcode's encoding mode, default mode is Auto See QRCodeDataMode.
`QRCodeECL`	`getQRErrorLevel()` Level of Reed-Solomon error correction for QR Barcode.
`Resolution`	`getResolution()` Gets the resolution of the Barcode image See `Resolution`.
`float`	`getRotationAngleF()` Barcode image's rotation angle, measured in degree, e.g.
`int`	`getRows()` 2D Barcode's rows, if setting is illegal then rows will be calculated automatically.
`java.lang.String`	`getSupplementData()` Supplement data following Barcodes of symbology UPCA, UPCE, EAN13, EAN8, BooklandEAN, Interleaved2of5 or Standard2of5.
`float`	`getSupplementSpace()` Space between main the Barcode and supplement Barcode, default Graphics Unit: millimeter See GraphicsUnit.
`SymbologyType`	`getSymbologyType()` Barcode's symbology, type: Spire.Barcode.SymbologyType See SymbologyType.
`TextLocation`	`getTextLocation()` Specify the displaying CodeText's Location, set to TextLocation.None to hide CodeText.
`TextRenderingHint`	`getTextRenderingHint()` Specifies the quality of text rendering.
`boolean`	`getThrowExceptionWhenCodeTextIncorrect()` Only for 1D barcodes.
`float`	`getWideNarrowRatio()` Wide bars to Narrow bars ratio for some 1D Barcode.
`float`	`getXPos()` x-dimension, smallest width unit of Barcode's bars or spaces.
`float`	`getYPos()` y-dimension, smallest height unit of 2D Barcode's modules.
`void`	`insertWatermark()`
`void`	`print()` Print BarcodeImage See `BarcodeCreator.getPrinterName()`.
`void`	`rotate()` Rotate Barcode image clockwise for 90 degrees
`void`	`rotate(float angle)` Rotate Barcode image clockwise
`void`	`rotate(RotationDirection direction, float angle)` Rotate the Barcode image
`void`	`save(com.spire.ms.System.IO.Stream stream, BarcodeImageFormat format)` Save BarcodeImage to stream in specific format
`void`	`save(com.spire.ms.System.IO.Stream stream, com.spire.ms.System.Drawing.Imaging.ImageFormat format)` Save BarcodeImage to specific file in specific format
`void`	`save(java.lang.String filename)` Save BarcodeImage to specific file in specific format
`void`	`save(java.lang.String filename, BarcodeImageFormat format)` Save BarcodeImage to specific file in specific format
`void`	`save(java.lang.String filename, com.spire.ms.System.Drawing.Imaging.ImageFormat format)` Save BarcodeImage to specific file in specific format
`void`	`saveAsEmf(com.spire.ms.System.IO.Stream stream)` Save the Barcode as Emf to stream.
`void`	`saveAsEmf(java.lang.String fileName)` Save the Barcode as Emf file using given file name.
`void`	`setAlwaysShowChecksum(boolean value)` Always display checksum digit in the humanreadable text for Code128 and EAN128 Barcodes.
`void`	`setAspectRatio(float value)` 2D Barcode's module's height/width ratio (yDimension/xDimension).
`void`	`setAustraliaPostFormatControlCode(AustraliaPostFormatControlCode value)` Australia Post symbology type of Barcode's FormatControlCode, default to AustraliaPostFormatControlCode.Standard" See AustraliaPostFormatControlCode.
`void`	`setAutoSize(boolean value)` Wether ajust image's size automatically.
`void`	`setAztectErrorLevel(int value)` Level of error corection of Aztect types of Barcode.
`void`	`setBackColor(com.spire.ms.System.Drawing.Color value)` Background color of the Barcode image See Color.
`void`	`setBarHeight(float value)` height of 1D Barcodes' bars.
`void`	`setBinaryCodeText(byte[] codeText)` Set the data to be encoded.
`void`	`setBorderColor(com.spire.ms.System.Drawing.Color value)` Barcode Image's border's color See Color.
`void`	`setBorderDashStyle(BorderDashStyle value)` Barcode Image's border's style See BorderDashStyle.
`void`	`setBorderVisible(boolean value)` whether Barcode Image's border is visible See `BarcodeCreator.getBorderWidth()`.
`void`	`setBorderWidth(float value)` Barcode Image's border's width Default Graphics Unit: Millimeter See `BarcodeCreator.getBorderVisible()`.
`void`	`setCodabarStartSymbol(CodabarChar value)` Start symbol (character) of codabar symbology See `BarcodeCreator.getCodabarStopSymbol()`.
`void`	`setCodabarStopSymbol(CodabarChar value)` Stop symbol (character) of codabar symbology See `BarcodeCreator.getCodabarStartSymbol()`.
`void`	`setCode128CodeSet(Code128SetMode value)`
`void`	`setCodeCaptionAbove(CodeCaption value)` CodeCaption Above the Barcode image.
`void`	`setCodeCaptionBelow(CodeCaption value)` CodeCaption Below the Barcode image.
`void`	`setCodeCaptionLogoImage(CodeCaption _logoCodeCaption)`
`void`	`setCodeText(java.lang.String value)` Data to be encoded, different types of Barcode may have different CodeText length restrictions See `BarcodeCreator.getEnableEscape()`.
`void`	`setCodeTextAlignment(StringAlignment value)` Sets the alignment of the code text.
`void`	`setCodeTextColor(com.spire.ms.System.Drawing.Color value)` Specify the displaying CodeText's Color See `BarcodeCreator.getCodeText()`.
`void`	`setCodeTextEncoding(com.spire.ms.System.Text.Encoding value)` Sets the encoding of codetext.
`void`	`setCodeTextFont(com.spire.ms.System.Drawing.Font value)` Specify the displaying CodeText's font See `BarcodeCreator.getCodeText()` .
`void`	`setCodeTextSpace(float value)` Space between the CodeText and the Barcode.
`void`	`setColumns(int value)` 2D Barcode's columns, if setting is illegal then columns will be calculated automatically appliable SymbologyType: Pdf417
`void`	`setDataMatrixEncodeMode(DataMatrixEncodeMode value)` Encode mode of Datamatrix Barcode, default to Auto `DataMatrixEncodeMode`.
`void`	`setDisplay2DText(java.lang.String value)` Sets the text will displayed on the Barcode's image.
`void`	`setEnableChecksum(EnableChecksum value)` Enable checksum during generation for 1D Barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies
`void`	`setEnableEscape(boolean value)` Indicates whether explains the character "\" as an escape character in CodeText property.
`void`	`setForeColor(com.spire.ms.System.Drawing.Color value)` Foreground color of the Barcode image, that is, Bar's color of 1D Barcode, Module's color of 2D Barcode See Color.
`void`	`setGraphicsUnit(GraphicsUnit value)` Measurement of various properties such as Width, Height etc.
`void`	`setImageHeight(float value)` Barcode image's height See `BarcodeCreator.getAutoSize()`., if AutoSize is true, ImageHeight will be increased accordingly Default Graphics Unit: Millimeter
`void`	`setImageQuality(ImageQualityMode value)` Graphics quality mode, when RotationAngleF not equal to 0, 90, 180 or 270, do set quality mode to anti-alias.
`void`	`setImageWidth(float value)` Barcode image's width See `BarcodeCreator.getAutoSize()`, if AutoSize is true, ImageWidth will be increased accordingly Default Graphics Unit: Millimeter
`void`	`setITF14BorderType(ITF14BorderType value)` Border type of ITF14 Barcode, quiet zone will be determined by margin settings.
`void`	`setMacroPdf417FileID(int value)` Sets macro pdf417 Barcode's file ID.
`void`	`setMacroPdf417SegmentID(int value)` Sets macro pdf417 Barcode's segment ID, which starts from 0, to MacroPdf417SegmentCount - 1.
`void`	`setMacroPdf417SegmentsCount(int value)` Sets whether this macro pdf417 Barcode is the last segment.
`void`	`setPdf417CompactionMode(Pdf417DataMode value)` Pdf417 symbology type of Barcode's compaction mode, default compaction mode is Auto See Pdf417DataMode.
`void`	`setPdf417ErrorLevel(Pdf417ECL value)` Sets Pdf417 symbology type of Barcode's error coccrection level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture
`void`	`setPdf417Truncate(boolean value)` whether pdf417 symbology type of Barcode is truncated (to reduce space)
`void`	`setPlanetShortBarHeight(float value)` Short bar's height of Planet Barcode, it has to be between 1 millimeter and 1.5 milimeters.
`void`	`setPostnetShortBarHeight(float value)` Short bar's height of Postnet Barcode, it has to be between 1 millimeter and 1.5 milimeter (0.04 inch and 0.06 inch).
`void`	`setPrinterName(java.lang.String value)` Choose printer, if not specified, Print() method will choose the first available printer
`void`	`setQREncodeMode(QRCodeDataMode value)` QR symbology type of Barcode's encoding mode, default mode is Auto See QRCodeDataMode.
`void`	`setQRErrorLevel(QRCodeECL value)` Level of Reed-Solomon error correction for QR Barcode.
`void`	`setResolution(Resolution value)` Sets the resolution of the Barcode image
`void`	`setRotationAngleF(float value)` Barcode image's rotation angle, measured in degree, e.g.
`void`	`setRows(int value)` 2D Barcode's rows, if setting is illegal then rows will be calculated automatically.
`void`	`setSupplementData(java.lang.String value)` Supplement data following Barcodes of symbology UPCA, UPCE, EAN13, EAN8, BooklandEAN, Interleaved2of5 or Standard2of5.
`void`	`setSupplementSpace(float value)` Space between main the Barcode and supplement Barcode, default Graphics Unit: millimeter See GraphicsUnit.
`void`	`setSymbologyType(SymbologyType value)` Barcode's symbology, type: Spire.Barcode.SymbologyType See SymbologyType.
`void`	`setTextLocation(TextLocation value)` Specify the displaying CodeText's Location, set to TextLocation.None to hide CodeText.
`void`	`setTextRenderingHint(TextRenderingHint value)` Specifies the quality of text rendering.
`void`	`setThrowExceptionWhenCodeTextIncorrect(boolean value)` Only for 1D barcodes.
`void`	`setWideNarrowRatio(float value)` Wide bars to Narrow bars ratio for some 1D Barcode.
`void`	`setXPos(float value)` x-dimension, smallest width unit of Barcode's bars or spaces.
`void`	`setYPos(float value)` y-dimension, smallest height unit of 2D Barcode's modules.
`java.lang.String`	`toString()` overried to string method

Constructor Detail

BarcodeCreator

public BarcodeCreator()

BarcodeGenerator's constructer, default SymbologyType is Code128, default CodeText is 12345678

BarcodeCreator

public BarcodeCreator(java.lang.String CodeText)

BarcodeGenerator's constructer, default SymbologyType is Code128

Parameters:: CodeText - string text data to be encoded

BarcodeCreator

public BarcodeCreator(java.lang.String CodeText,
                      SymbologyType type)

BarcodeGenerator's constructer

Parameters:: CodeText - string text data to be encoded; type - Barcode's type: Spire.Barcode.SymbologyType

Method Detail

getBarcodeImageCodeCaptionAbove

public CodeCaption getBarcodeImageCodeCaptionAbove()

getSymbologyType

public SymbologyType getSymbologyType()

Barcode's symbology, type: Spire.Barcode.SymbologyType See SymbologyType. supported symbology: 1D: Codabar, Code11, Code128, Code39Standard, Code39Extended Code93Standard, Code93Extended, EAN13, EAN8, Interleaved2of5, MSI, Standard2of5, UPCA, UPCE, EAN14, SCC14, SSCC18, ITF14, OneCode, SingaporePost 2D: DataMatrix, PDf417,MacroPDF

setSymbologyType

public void setSymbologyType(SymbologyType value)

getCodeText

public java.lang.String getCodeText()

Data to be encoded, different types of Barcode may have different CodeText length restrictions See BarcodeCreator.getEnableEscape(). See BarcodeCreator.getCodeTextFont(). See BarcodeCreator.getCodeTextColor(). See TextLocation. See BarcodeCreator.getCodeTextSpace(). See BarcodeCreator.getCodeTextAlignment().

setCodeText

public void setCodeText(java.lang.String value)

setBinaryCodeText

public void setBinaryCodeText(byte[] codeText)

Set the data to be encoded.

Parameters:: codeText -

getDisplay2DText

public java.lang.String getDisplay2DText()

Gets the text will displayed on the Barcode's image. Available only for 2D Barcodes. Limited to 1000 chars.

Returns:: The text to display.

setDisplay2DText

public void setDisplay2DText(java.lang.String value)

Sets the text will displayed on the Barcode's image. Available only for 2D Barcodes. Limited to 1000 chars.

Parameters:: value - The text to display.

getCodeTextEncoding

public com.spire.ms.System.Text.Encoding getCodeTextEncoding()

Gets the encoding of codetext.

Returns:: The encoding for codetext.

setCodeTextEncoding

public void setCodeTextEncoding(com.spire.ms.System.Text.Encoding value)

Sets the encoding of codetext.

Parameters:: value - The encoding for codetext.

getEnableEscape

public boolean getEnableEscape()

Indicates whether explains the character "\" as an escape character in CodeText property. See BarcodeCreator.getCodeText(). If the EnableEscape is true, "\" will be explained as a special escape character. Otherwise, "\" acts as normal characters. Spire.Barcode supports inputing decimal ascii code and mnemonic for ASCII control-code characters, 0 through 31. For example, \013 and \CR stands for CR.

setEnableEscape

public void setEnableEscape(boolean value)

getCodeTextFont

public com.spire.ms.System.Drawing.Font getCodeTextFont()

Specify the displaying CodeText's font See BarcodeCreator.getCodeText() . See Font. See BarcodeCreator.getCodeTextColor(). See TextLocation. See BarcodeCreator.getCodeTextSpace(). See BarcodeCreator.getCodeTextAlignment().

setCodeTextFont

public void setCodeTextFont(com.spire.ms.System.Drawing.Font value)

getCodeTextColor

public com.spire.ms.System.Drawing.Color getCodeTextColor()

Specify the displaying CodeText's Color See BarcodeCreator.getCodeText(). See BarcodeCreator.getCodeTextFont(). See TextLocation. See BarcodeCreator.getCodeTextSpace(). See BarcodeCreator.getCodeTextAlignment() .

Returns:: Color

setCodeTextColor

public void setCodeTextColor(com.spire.ms.System.Drawing.Color value)

getTextLocation

public TextLocation getTextLocation()

Specify the displaying CodeText's Location, set to TextLocation.None to hide CodeText. TextLocation will be ignored if SymbologyType is UPCE, UPCA, BooklandEAN, EAN8 or EAN13 See TextLocation. See BarcodeCreator.getCodeText(). See BarcodeCreator.getCodeTextFont(). See BarcodeCreator.getCodeTextSpace(). See BarcodeCreator.getCodeTextColor(). See BarcodeCreator.getCodeTextAlignment().

setTextLocation

public void setTextLocation(TextLocation value)

getCodeTextAlignment

public StringAlignment getCodeTextAlignment()

Gets the alignment of the code text. See StringAlignment. See BarcodeCreator.getCodeText(). See BarcodeCreator.getCodeTextFont(). See BarcodeCreator.getCodeTextColor(). See BarcodeCreator.getCodeTextSpace(). StringAlignment.Near means CodeText will be aligned to the left StringAlignment.Far means CodeText will be aligned to the right StringAlignment.Center means CodeText will be aligned to the center

setCodeTextAlignment

public void setCodeTextAlignment(StringAlignment value)

Sets the alignment of the code text.

Parameters:: value - See StringAlignment. See BarcodeCreator.getCodeText(). See BarcodeCreator.getCodeTextFont(). See BarcodeCreator.getCodeTextColor(). See BarcodeCreator.getCodeTextSpace(). StringAlignment.Near means CodeText will be aligned to the left StringAlignment.Far means CodeText will be aligned to the right StringAlignment.Center means CodeText will be aligned to the center

getRotationAngleF

public float getRotationAngleF()

Barcode image's rotation angle, measured in degree, e.g. RotationAngleF = 0 or RotationAngleF = 360 means no rotation If RotationAngleF NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image, please set quality mode to anti-alias

setRotationAngleF

public void setRotationAngleF(float value)

getCodeCaptionAbove

public CodeCaption getCodeCaptionAbove()

CodeCaption Above the Barcode image. See CodeCaption. CodeCaptionAbove contains the following properties: CodeCaptionAbove.Font, CodeCaptionAbove.ForeColor, CodeCaptionAbove.Space, CodeCaptionAbove.Visible, CodeCaptionAbove.Text, CodeCaptionAbove.TextAlign

setCodeCaptionAbove

public void setCodeCaptionAbove(CodeCaption value)

getCodeCaptionBelow

public CodeCaption getCodeCaptionBelow()

CodeCaption Below the Barcode image. See CodeCaption. CodeCaptionBelow contains the following properties: CodeCaptionBelow.Font, CodeCaptionBelow.ForeColor, CodeCaptionBelow.Space, CodeCaptionBelow.Visible, CodeCaptionBelow.Text, CodeCaptionBelow.TextAlign

setCodeCaptionBelow

public void setCodeCaptionBelow(CodeCaption value)

getGraphicsUnit

public GraphicsUnit getGraphicsUnit()

Measurement of various properties such as Width, Height etc. Default GraphicsUnit: Millimeter See GraphicsUnit.

setGraphicsUnit

public void setGraphicsUnit(GraphicsUnit value)

Measurement of various properties such as Width, Height etc. Default GraphicsUnit: Millimeter See GraphicsUnit.

getResolution

public Resolution getResolution()

Gets the resolution of the Barcode image See Resolution.

Returns:: Resolution

setResolution

public void setResolution(Resolution value)

Sets the resolution of the Barcode image

Parameters:: value - See Resolution.

getPrinterName

public java.lang.String getPrinterName()

Choose printer, if not specified, Print() method will choose the first available printer

Returns:: String

setPrinterName

public void setPrinterName(java.lang.String value)

Choose printer, if not specified, Print() method will choose the first available printer

getImageQuality

public ImageQualityMode getImageQuality()

Graphics quality mode, when RotationAngleF not equal to 0, 90, 180 or 270, do set quality mode to anti-alias. Type: Spire.Barcode.ImageQualityMode See ImageQualityMode.

setImageQuality

public void setImageQuality(ImageQualityMode value)

Graphics quality mode, when RotationAngleF not equal to 0, 90, 180 or 270, do set quality mode to anti-alias. Type: Spire.Barcode.ImageQualityMode See ImageQualityMode.

getTextRenderingHint

public TextRenderingHint getTextRenderingHint()

Specifies the quality of text rendering.

setTextRenderingHint

public void setTextRenderingHint(TextRenderingHint value)

Specifies the quality of text rendering.

getAutoSize

public boolean getAutoSize()

Wether ajust image's size automatically. Recommended:true

setAutoSize

public void setAutoSize(boolean value)

Wether ajust image's size automatically. Recommended:true

getImageWidth

public float getImageWidth()

Barcode image's width See BarcodeCreator.getAutoSize(), if AutoSize is true, ImageWidth will be increased accordingly Default Graphics Unit: Millimeter

setImageWidth

public void setImageWidth(float value)

Barcode image's width See BarcodeCreator.getAutoSize(), if AutoSize is true, ImageWidth will be increased accordingly Default Graphics Unit: Millimeter

getImageHeight

public float getImageHeight()

Barcode image's height See BarcodeCreator.getAutoSize()., if AutoSize is true, ImageHeight will be increased accordingly Default Graphics Unit: Millimeter

setImageHeight

public void setImageHeight(float value)

Barcode image's height See BarcodeCreator.getAutoSize()., if AutoSize is true, ImageHeight will be increased accordingly Default Graphics Unit: Millimeter

getBorderWidth

public float getBorderWidth()

Barcode Image's border's width Default Graphics Unit: Millimeter See BarcodeCreator.getBorderVisible(). See BorderDashStyle. See BarcodeCreator.getBorderColor().

setBorderWidth

public void setBorderWidth(float value)

Barcode Image's border's width Default Graphics Unit: Millimeter See BarcodeCreator.getBorderVisible(). See BorderDashStyle. See BarcodeCreator.getBorderColor().

getXPos

public float getXPos()

x-dimension, smallest width unit of Barcode's bars or spaces. increase this will increase the whole Barcode image's width if AutoSize is true Default Graphics Unit: Millimeter

See Also:: GDIVisualParametersBase.yDimension, BarcodeCreator.getAutoSize(), BarcodeCreator.getBarHeight()

setXPos

public void setXPos(float value)

x-dimension, smallest width unit of Barcode's bars or spaces. increase this will increase the whole Barcode image's width if AutoSize is true Default Graphics Unit: Millimeter

See Also:: GDIVisualParametersBase.yDimension, BarcodeCreator.getAutoSize(), BarcodeCreator.getBarHeight()

getYPos

public float getYPos()

y-dimension, smallest height unit of 2D Barcode's modules. Some square symbols (such as DataMatrix) may ignore this and use x-dimension for both width unit and height unit

In 2D Barcode, y-dimension * rows determines Barcode's height In 1D Barcode, BarHeight determines Barcode's height. Default Graphics Unit: Millimeter

See Also:: GDIVisualParametersBase.xDimension, BarcodeCreator.getBarHeight()

setYPos

public void setYPos(float value)

y-dimension, smallest height unit of 2D Barcode's modules. Some square symbols (such as DataMatrix) may ignore this and use x-dimension for both width unit and height unit

In 2D Barcode, y-dimension * rows determines Barcode's height In 1D Barcode, BarHeight determines Barcode's height. Default Graphics Unit: Millimeter

See Also:: GDIVisualParametersBase.xDimension, BarcodeCreator.getBarHeight()

getBarHeight

public float getBarHeight()

height of 1D Barcodes' bars. In 2D Barcode, y-dimension * rows determines Barcode's height In 1D Barcode, BarHeight determines Barcode's height. Default Graphics Unit: Millimeter See GDIVisualParametersBase.yDimension.

See Also:: GDIVisualParametersBase.yDimension

setBarHeight

public void setBarHeight(float value)

See Also:: GDIVisualParametersBase.yDimension

getAspectRatio

public float getAspectRatio()

2D Barcode's module's height/width ratio (yDimension/xDimension). calculated based on xDimension set to 0 means not using this feature. See xDimension. See

See Also:: Some 2D Barcodes are square shaped, then AspectRatio is not appliable

setAspectRatio

public void setAspectRatio(float value)

2D Barcode's module's height/width ratio (yDimension/xDimension). calculated based on xDimension set to 0 means not using this feature. See xDimension. See

See Also:: Some 2D Barcodes are square shaped, then AspectRatio is not appliable

getMargins

public MarginsF getMargins()

Margin area around the core Barcode image If AutoSize is false, then Width and Height is fixed, thus Margins setting will be ignored Default Graphics Unit: Millimeter

getSupplementSpace

public float getSupplementSpace()

Space between main the Barcode and supplement Barcode, default Graphics Unit: millimeter See GraphicsUnit. See BarcodeCreator.getSupplementData().

setSupplementSpace

public void setSupplementSpace(float value)

Space between main the Barcode and supplement Barcode, default Graphics Unit: millimeter See GraphicsUnit. See BarcodeCreator.getSupplementData().

getPostnetShortBarHeight

public float getPostnetShortBarHeight()

Short bar's height of Postnet Barcode, it has to be between 1 millimeter and 1.5 milimeter (0.04 inch and 0.06 inch). To set up tall bar's height, see BarHeight, which has to be between 8.28 milimeter and 9.72 milimeter (0.115 inch and 0.135 inch) see changing See GraphicsUnit. see setting tall bar's height: See BarcodeCreator.getBarHeight().

setPostnetShortBarHeight

public void setPostnetShortBarHeight(float value)

getPlanetShortBarHeight

public float getPlanetShortBarHeight()

Short bar's height of Planet Barcode, it has to be between 1 millimeter and 1.5 milimeters. see changing See GraphicsUnit. see setting tall bar's height: See BarcodeCreator.getBarHeight() }.

setPlanetShortBarHeight

public void setPlanetShortBarHeight(float value)

Short bar's height of Planet Barcode, it has to be between 1 millimeter and 1.5 milimeters. see changing See GraphicsUnit. see setting tall bar's height: See BarcodeCreator.getBarHeight() }.

getCodeTextSpace

public float getCodeTextSpace()

Space between the CodeText and the Barcode. Default Graphics Unit: Millimeter See BarcodeCreator.getCodeText(). See TextLocation. See BarcodeCreator.getCodeTextFont(). See BarcodeCreator.getCodeTextColor(). See BarcodeCreator.getCodeTextAlignment().

setCodeTextSpace

public void setCodeTextSpace(float value)

getBarcodeImage

public com.spire.ms.System.Drawing.Bitmap getBarcodeImage()

getBorderVisible

public boolean getBorderVisible()

whether Barcode Image's border is visible See BarcodeCreator.getBorderWidth(). See BorderDashStyle. See BarcodeCreator.getBorderColor().

setBorderVisible

public void setBorderVisible(boolean value)

whether Barcode Image's border is visible See BarcodeCreator.getBorderWidth(). See BorderDashStyle. See BarcodeCreator.getBorderColor().

getBorderColor

public com.spire.ms.System.Drawing.Color getBorderColor()

Barcode Image's border's color See Color. See BarcodeCreator.getBorderWidth(). See BarcodeCreator.getBorderVisible(). See BarcodeCreator.getBorderDashStyle()

setBorderColor

public void setBorderColor(com.spire.ms.System.Drawing.Color value)

Barcode Image's border's color See Color. See BarcodeCreator.getBorderWidth(). See BarcodeCreator.getBorderVisible(). See BarcodeCreator.getBorderDashStyle()

getBorderDashStyle

public BorderDashStyle getBorderDashStyle()

Barcode Image's border's style See BorderDashStyle. See BarcodeCreator.getBorderWidth() }. See BarcodeCreator.getBorderVisible(). See BarcodeCreator.getBorderColor().

setBorderDashStyle

public void setBorderDashStyle(BorderDashStyle value)

Barcode Image's border's style See BorderDashStyle. See BarcodeCreator.getBorderWidth() }. See BarcodeCreator.getBorderVisible(). See BarcodeCreator.getBorderColor().

getCodabarStartSymbol

public CodabarChar getCodabarStartSymbol()

Start symbol (character) of codabar symbology See BarcodeCreator.getCodabarStopSymbol(). See CodabarChar.

setCodabarStartSymbol

public void setCodabarStartSymbol(CodabarChar value)

Start symbol (character) of codabar symbology See BarcodeCreator.getCodabarStopSymbol(). See CodabarChar.

getCodabarStopSymbol

public CodabarChar getCodabarStopSymbol()

Stop symbol (character) of codabar symbology See BarcodeCreator.getCodabarStartSymbol(). See CodabarChar.

setCodabarStopSymbol

public void setCodabarStopSymbol(CodabarChar value)

Stop symbol (character) of codabar symbology See BarcodeCreator.getCodabarStartSymbol(). See CodabarChar.

getCode128CodeSet

public Code128SetMode getCode128CodeSet()

setCode128CodeSet

public void setCode128CodeSet(Code128SetMode value)

getEAN128EncodeMode

public EAN128EncodeMode getEAN128EncodeMode()

getAustraliaPostFormatControlCode

public AustraliaPostFormatControlCode getAustraliaPostFormatControlCode()

Australia Post symbology type of Barcode's FormatControlCode, default to AustraliaPostFormatControlCode.Standard" See AustraliaPostFormatControlCode.

setAustraliaPostFormatControlCode

public void setAustraliaPostFormatControlCode(AustraliaPostFormatControlCode value)

Australia Post symbology type of Barcode's FormatControlCode, default to AustraliaPostFormatControlCode.Standard" See AustraliaPostFormatControlCode.

getITF14BorderType

public ITF14BorderType getITF14BorderType()

Border type of ITF14 Barcode, quiet zone will be determined by margin settings. See Margins.

setITF14BorderType

public void setITF14BorderType(ITF14BorderType value)

Border type of ITF14 Barcode, quiet zone will be determined by margin settings. See Margins.

getForeColor

public com.spire.ms.System.Drawing.Color getForeColor()

Foreground color of the Barcode image, that is, Bar's color of 1D Barcode, Module's color of 2D Barcode See Color.

setForeColor

public void setForeColor(com.spire.ms.System.Drawing.Color value)

Foreground color of the Barcode image, that is, Bar's color of 1D Barcode, Module's color of 2D Barcode See Color.

getBackColor

public com.spire.ms.System.Drawing.Color getBackColor()

Background color of the Barcode image See Color.

setBackColor

public void setBackColor(com.spire.ms.System.Drawing.Color value)

Background color of the Barcode image See Color.

getEnableChecksum

public EnableChecksum getEnableChecksum()

Enable checksum during generation for 1D Barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies

setEnableChecksum

public void setEnableChecksum(EnableChecksum value)

getThrowExceptionWhenCodeTextIncorrect

public boolean getThrowExceptionWhenCodeTextIncorrect()

Only for 1D barcodes. If codetext is incorrect and value set to true - exception will be thrown. Overwise codetext will be corrected to match barcode's specification. Exception always will be thrown for: Databar symbologies if codetext is incorrect. Exception always will not be thrown for: AustraliaPost, SingapurePost, Code39Extended, Code93Extended, Code16K, Code128 symbologies if codetext is incorrect.

setThrowExceptionWhenCodeTextIncorrect

public void setThrowExceptionWhenCodeTextIncorrect(boolean value)

getColumns

public int getColumns()

2D Barcode's columns, if setting is illegal then columns will be calculated automatically appliable SymbologyType: Pdf417

setColumns

public void setColumns(int value)

2D Barcode's columns, if setting is illegal then columns will be calculated automatically appliable SymbologyType: Pdf417

getRows

public int getRows()

2D Barcode's rows, if setting is illegal then rows will be calculated automatically. appliable SymbologyType: Pdf417

setRows

public void setRows(int value)

2D Barcode's rows, if setting is illegal then rows will be calculated automatically. appliable SymbologyType: Pdf417

getDataMatrixEncodeMode

public DataMatrixEncodeMode getDataMatrixEncodeMode()

Encode mode of Datamatrix Barcode, default to Auto DataMatrixEncodeMode.

setDataMatrixEncodeMode

public void setDataMatrixEncodeMode(DataMatrixEncodeMode value)

Encode mode of Datamatrix Barcode, default to Auto DataMatrixEncodeMode.

getPdf417CompactionMode

public Pdf417DataMode getPdf417CompactionMode()

Pdf417 symbology type of Barcode's compaction mode, default compaction mode is Auto See Pdf417DataMode.

setPdf417CompactionMode

public void setPdf417CompactionMode(Pdf417DataMode value)

Pdf417 symbology type of Barcode's compaction mode, default compaction mode is Auto See Pdf417DataMode.

getPdf417Truncate

public boolean getPdf417Truncate()

whether pdf417 symbology type of Barcode is truncated (to reduce space)

setPdf417Truncate

public void setPdf417Truncate(boolean value)

whether pdf417 symbology type of Barcode is truncated (to reduce space)

getPdf417ErrorLevel

public Pdf417ECL getPdf417ErrorLevel()

Gets Pdf417 symbology type of Barcode's error coccrection level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture

setPdf417ErrorLevel

public void setPdf417ErrorLevel(Pdf417ECL value)

Sets Pdf417 symbology type of Barcode's error coccrection level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture

Parameters:: value -

getMacroPdf417SegmentsCount

public int getMacroPdf417SegmentsCount()

Gets whether this macro pdf417 Barcode is the last segment.

setMacroPdf417SegmentsCount

public void setMacroPdf417SegmentsCount(int value)

Sets whether this macro pdf417 Barcode is the last segment.

Parameters:: value -

getMacroPdf417SegmentID

public int getMacroPdf417SegmentID()

Gets macro pdf417 Barcode's segment ID, which starts from 0, to MacroPdf417SegmentCount - 1.

setMacroPdf417SegmentID

public void setMacroPdf417SegmentID(int value)

Sets macro pdf417 Barcode's segment ID, which starts from 0, to MacroPdf417SegmentCount - 1.

Parameters:: value -

getMacroPdf417FileID

public int getMacroPdf417FileID()

Gets macro pdf417 Barcode's file ID.

setMacroPdf417FileID

public void setMacroPdf417FileID(int value)

Sets macro pdf417 Barcode's file ID.

Parameters:: value -

getWideNarrowRatio

public float getWideNarrowRatio()

Wide bars to Narrow bars ratio for some 1D Barcode. Default WideNarrowRatio:3, that is, wide bars are 3 times as wide as narrow bars Appliable symbology: Code39Extended, Code39Standard, Standard2of5, Interleaved2of5, Pharmacode See SymbologyType.

setWideNarrowRatio

public void setWideNarrowRatio(float value)

getSupplementData

public java.lang.String getSupplementData()

Supplement data following Barcodes of symbology UPCA, UPCE, EAN13, EAN8, BooklandEAN, Interleaved2of5 or Standard2of5. See SymbologyType. See BarcodeCreator.getSupplementSpace().

setSupplementData

public void setSupplementData(java.lang.String value)

Supplement data following Barcodes of symbology UPCA, UPCE, EAN13, EAN8, BooklandEAN, Interleaved2of5 or Standard2of5. See SymbologyType. See BarcodeCreator.getSupplementSpace().

getQRErrorLevel

public QRCodeECL getQRErrorLevel()

Level of Reed-Solomon error correction for QR Barcode. From low to high: LevelL, LevelM, LevelQ, LevelH. see BarcodeCreator.getQRErrorLevel().

setQRErrorLevel

public void setQRErrorLevel(QRCodeECL value)

Level of Reed-Solomon error correction for QR Barcode. From low to high: LevelL, LevelM, LevelQ, LevelH. see BarcodeCreator.getQRErrorLevel().

getQREncodeMode

public QRCodeDataMode getQREncodeMode()

QR symbology type of Barcode's encoding mode, default mode is Auto See QRCodeDataMode.

setQREncodeMode

public void setQREncodeMode(QRCodeDataMode value)

QR symbology type of Barcode's encoding mode, default mode is Auto See QRCodeDataMode.

getAztectErrorLevel

public int getAztectErrorLevel()

Level of error corection of Aztect types of Barcode. value should between 10 to 95

setAztectErrorLevel

public void setAztectErrorLevel(int value)

Level of error corection of Aztect types of Barcode. value should between 10 to 95

getAlwaysShowChecksum

public boolean getAlwaysShowChecksum()

Always display checksum digit in the humanreadable text for Code128 and EAN128 Barcodes.

Returns:: boolean

setAlwaysShowChecksum

public void setAlwaysShowChecksum(boolean value)

Always display checksum digit in the humanreadable text for Code128 and EAN128 Barcodes.

Parameters:: value -

insertWatermark

public void insertWatermark()

dispose

@Deprecated
public void dispose()

Deprecated.

Clean up any resources being used.

generateBarcodeImage

public com.spire.ms.System.Drawing.Bitmap generateBarcodeImage()

Generate the Barcode image under current settings

Returns:: Barcode Image See Bitmap

saveAsEmf

public void saveAsEmf(java.lang.String fileName)

Save the Barcode as Emf file using given file name.

Parameters:: fileName - The file name.
Throws:: java.lang.Exception

saveAsEmf

public void saveAsEmf(com.spire.ms.System.IO.Stream stream)

Save the Barcode as Emf to stream.

Parameters:: stream - System.IO.Stream
Throws:: java.lang.Exception

rotate

public void rotate()

Rotate Barcode image clockwise for 90 degrees

rotate

public void rotate(float angle)

Rotate Barcode image clockwise

Parameters:: angle - Rotation Angle

rotate

public void rotate(RotationDirection direction,
                   float angle)

Rotate the Barcode image

Parameters:: direction - rotation direction; angle - rotation angle

print

public void print()

Print BarcodeImage See BarcodeCreator.getPrinterName().

getCustomSizeBarCodeImage

public com.spire.ms.System.Drawing.Bitmap getCustomSizeBarCodeImage(com.spire.ms.System.Drawing.Size customBarCodeSize,
                                                                    boolean allowSpaceAround)

Gets the scaled barcode image.

Parameters:: customBarCodeSize - BarCode full image size. Default Graphics Unit: Millimeter.; allowSpaceAround - if set to true allow space around the barcode.
Returns:: Image's bitmap.

save

public void save(com.spire.ms.System.IO.Stream stream,
                 com.spire.ms.System.Drawing.Imaging.ImageFormat format)

Save BarcodeImage to specific file in specific format

Parameters:: stream - System.IO.Stream; format - System.Drawing.Imaging.ImageFormat

save

public void save(com.spire.ms.System.IO.Stream stream,
                 BarcodeImageFormat format)

Save BarcodeImage to stream in specific format

Parameters:: stream - System.IO.Stream; format - Specifies the file format of the image.

save

public void save(java.lang.String filename)

Save BarcodeImage to specific file in specific format

Parameters:: filename - save to this file path

save

public void save(java.lang.String filename,
                 com.spire.ms.System.Drawing.Imaging.ImageFormat format)

Save BarcodeImage to specific file in specific format

Parameters:: filename - save to this file path; format - System.Drawing.Imaging.ImageFormat

save

public void save(java.lang.String filename,
                 BarcodeImageFormat format)

Save BarcodeImage to specific file in specific format

Parameters:: filename - save to this file path; format - Specifies the file format of the image.

toString

public java.lang.String toString()

overried to string method

Overrides:: toString in class java.lang.Object

Returns:: Barcode: SymbologyType: CodeText

getCodeCaptionLogoImage

public CodeCaption getCodeCaptionLogoImage()

setCodeCaptionLogoImage

public void setCodeCaptionLogoImage(CodeCaption _logoCodeCaption)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.spire.barcode.implementation.generator.generation Class BarcodeCreator

BarcodeCreator

BarcodeCreator

BarcodeCreator

getBarcodeImageCodeCaptionAbove

getSymbologyType

setSymbologyType

getCodeText

setCodeText

setBinaryCodeText

getDisplay2DText

setDisplay2DText

getCodeTextEncoding

setCodeTextEncoding

getEnableEscape

setEnableEscape

getCodeTextFont

setCodeTextFont

getCodeTextColor

setCodeTextColor

getTextLocation

setTextLocation

getCodeTextAlignment

setCodeTextAlignment

getRotationAngleF

setRotationAngleF

getCodeCaptionAbove

setCodeCaptionAbove

getCodeCaptionBelow

setCodeCaptionBelow

getGraphicsUnit

setGraphicsUnit

getResolution

setResolution

getPrinterName

setPrinterName

getImageQuality

setImageQuality

getTextRenderingHint

setTextRenderingHint

getAutoSize

setAutoSize

getImageWidth

setImageWidth

getImageHeight

setImageHeight

getBorderWidth

setBorderWidth

getXPos

setXPos

getYPos

setYPos

getBarHeight

setBarHeight

getAspectRatio

setAspectRatio

getMargins

getSupplementSpace

setSupplementSpace

getPostnetShortBarHeight

setPostnetShortBarHeight

getPlanetShortBarHeight

setPlanetShortBarHeight

getCodeTextSpace

setCodeTextSpace

getBarcodeImage

getBorderVisible

setBorderVisible

getBorderColor

setBorderColor

getBorderDashStyle

setBorderDashStyle

getCodabarStartSymbol

setCodabarStartSymbol

getCodabarStopSymbol

setCodabarStopSymbol

getCode128CodeSet

setCode128CodeSet

getEAN128EncodeMode

getAustraliaPostFormatControlCode

com.spire.barcode.implementation.generator.generation
Class BarcodeCreator