iText 8.0.5 API
iText.Barcodes.BarcodePostnet Class Reference

POSTNET (Postal Numeric Encoding Technique) is a barcode symbology used by the United States Postal Service to assist in directing mail. More...

Inheritance diagram for iText.Barcodes.BarcodePostnet:
iText.Barcodes.Barcode1D

Public Member Functions

  BarcodePostnet (PdfDocument document)
  Creates new BarcodePostnet instance. More...
 
override Rectangle  GetBarcodeSize ()
  Gets the maximum area that the barcode and the text, if any, will occupy. More...
 
override void  FitWidth (float width)
  Make the barcode occupy the specified width. More...
 
override Rectangle  PlaceBarcode (PdfCanvas canvas, Color barColor, Color textColor)
  Places the barcode in a PdfCanvas. More...
 
- Public Member Functions inherited from iText.Barcodes.Barcode1D
virtual float  GetX ()
  Gets the minimum bar width. More...
 
virtual void  SetX (float x)
  Sets the minimum bar width. More...
 
virtual float  GetN ()
  Gets the bar multiplier for wide bars. More...
 
virtual void  SetN (float n)
  Sets the bar multiplier for wide bars. More...
 
virtual PdfFont  GetFont ()
  Gets the text font. More...
 
virtual void  SetFont (PdfFont font)
  Sets the text font. More...
 
virtual float  GetSize ()
  Gets the size of the text. More...
 
virtual void  SetSize (float size)
  Sets the size of the text. More...
 
virtual float  GetBaseline ()
  Gets the text baseline. More...
 
virtual void  SetBaseline (float baseline)
  Sets the text baseline. More...
 
virtual float  GetBarHeight ()
  Gets the height of the bars. More...
 
virtual void  SetBarHeight (float barHeight)
  Sets the height of the bars. More...
 
virtual int  GetTextAlignment ()
  Gets the text alignment. More...
 
virtual void  SetTextAlignment (int textAlignment)
  Sets the text alignment. More...
 
virtual bool  IsGenerateChecksum ()
  Gets the optional checksum generation. More...
 
virtual void  SetGenerateChecksum (bool generateChecksum)
  Setter for property generateChecksum. More...
 
virtual bool  IsChecksumText ()
  Gets the property to show the generated checksum in the the text. More...
 
virtual void  SetChecksumText (bool checksumText)
  Sets the property to show the generated checksum in the the text. More...
 
virtual bool  IsStartStopText ()
  Sets the property to show the start and stop character '*' in the text for the barcode 39. More...
 
virtual void  SetStartStopText (bool startStopText)
  Gets the property to show the start and stop character '*' in the text for the barcode 39. More...
 
virtual bool  IsExtended ()
  Gets the property to generate extended barcode 39. More...
 
virtual void  SetExtended (bool extended)
  Sets the property to generate extended barcode 39. More...
 
virtual String  GetCode ()
  Gets the code to generate. More...
 
virtual void  SetCode (String code)
  Sets the code to generate. More...
 
virtual bool  IsGuardBars ()
  Gets the property to show the guard bars for barcode EAN. More...
 
virtual void  SetGuardBars (bool guardBars)
  Sets the property to show the guard bars for barcode EAN. More...
 
virtual int  GetCodeType ()
  Gets the code type. More...
 
virtual void  SetCodeType (int codeType)
  Sets the code type. More...
 
virtual float  GetInkSpreading ()
  Gets the amount of ink spreading. More...
 
virtual void  SetInkSpreading (float inkSpreading)
  Sets the amount of ink spreading. More...
 
virtual String  GetAltText ()
  Gets the alternate text. More...
 
virtual void  SetAltText (String altText)
  Sets the alternate text. More...
 
virtual PdfFormXObject  CreateFormXObject (PdfDocument document)
  Creates a PdfFormXObject with the barcode. More...
 
virtual PdfFormXObject  CreateFormXObject (Color barColor, Color textColor, PdfDocument document)
  Creates a PdfFormXObject with the barcode. More...
 

Static Public Member Functions

static byte[]  GetBarsPostnet (String text)
  Creates the bars for Postnet. More...
 

Static Public Attributes

static int  TYPE_POSTNET = 1
 
static int  TYPE_PLANET = 2
 
- Static Public Attributes inherited from iText.Barcodes.Barcode1D
const int  ALIGN_LEFT = 1
  Constant that defines left alignment. More...
 
const int  ALIGN_RIGHT = 2
  Constant that defines right alignment. More...
 
const int  ALIGN_CENTER = 3
  Constant that defines center alignment. More...
 

Additional Inherited Members

- Package Functions inherited from iText.Barcodes.Barcode1D
  Barcode1D (PdfDocument document)
  Creates new Barcode1D instance. More...
 
virtual float  GetDescender ()
  Gets the descender value of the font. More...
 
- Package Attributes inherited from iText.Barcodes.Barcode1D
PdfDocument  document
 
float  x
  The minimum bar width. More...
 
float  n
  The bar multiplier for wide bars or the distance between bars for Postnet and Planet. More...
 
PdfFont  font
  The text font. More...
 
float  size
  The size of the text or the height of the shorter bar in Postnet. More...
 
float  baseline
  If positive, the text distance under the bars. More...
 
float  barHeight
  The height of the bars. More...
 
int  textAlignment
  The text alignment. More...
 
bool  generateChecksum
  The optional checksum generation. More...
 
bool  checksumText
  Shows the generated checksum in the the text. More...
 
bool  startStopText
  Show the start and stop character '*' in the text for the barcode 39 or 'ABCD' for codabar. More...
 
bool  extended
  Generates extended barcode 39. More...
 
String  code = ""
  The code to generate. More...
 
bool  guardBars
  Show the guard bars for barcode EAN. More...
 
int  codeType
  The code type. More...
 
float  inkSpreading = 0
  The ink spreading. More...
 
String  altText
  The alternate text to be used, if present. More...
 

Detailed Description

POSTNET (Postal Numeric Encoding Technique) is a barcode symbology used by the United States Postal Service to assist in directing mail.

POSTNET (Postal Numeric Encoding Technique) is a barcode symbology used by the United States Postal Service to assist in directing mail. The ZIP Code or ZIP+4 code is encoded in half- and full-height bars.[1] Most often, the delivery point is added, usually being the last two digits of the address or PO box number.

Constructor & Destructor Documentation

◆ BarcodePostnet()

iText.Barcodes.BarcodePostnet.BarcodePostnet ( PdfDocument  document )
inline

Creates new BarcodePostnet instance.

Parameters
document The document

Member Function Documentation

◆ FitWidth()

override void iText.Barcodes.BarcodePostnet.FitWidth ( float  width )
inlinevirtual

Make the barcode occupy the specified width.

Make the barcode occupy the specified width. Usually this is achieved by adjusting bar widths.

Parameters
width The width

Reimplemented from iText.Barcodes.Barcode1D.

◆ GetBarcodeSize()

override Rectangle iText.Barcodes.BarcodePostnet.GetBarcodeSize ( )
inlinevirtual

Gets the maximum area that the barcode and the text, if any, will occupy.

Gets the maximum area that the barcode and the text, if any, will occupy. The lower left corner is always (0, 0).

Returns
the size the barcode occupies.

Implements iText.Barcodes.Barcode1D.

◆ GetBarsPostnet()

static byte [] iText.Barcodes.BarcodePostnet.GetBarsPostnet ( String  text )
inlinestatic

Creates the bars for Postnet.

Parameters
text the code to be created without checksum
Returns
the bars

◆ PlaceBarcode()

override Rectangle iText.Barcodes.BarcodePostnet.PlaceBarcode ( PdfCanvas  canvas,
Color  barColor,
Color  textColor 
)
inlinevirtual

Places the barcode in a PdfCanvas.

Places the barcode in a PdfCanvas. The barcode is always placed at coordinates (0, 0). Use the translation matrix to move it elsewhere.

The bars and text are written in the following colors:

barColor textColor Result
null null bars and text painted with current fill color
barColor null bars and text painted with barColor
null textColor bars painted with current color
text painted with textColor
barColor textColor bars painted with barColor
text painted with textColor
Parameters
canvas the PdfCanvas where the barcode will be placed
barColor the color of the bars. It can be null
textColor the color of the text. It can be null
Returns
the dimensions the barcode occupies

Implements iText.Barcodes.Barcode1D.