UniPRT SDK  v1.0.0.0
APdf417 Class Referenceabstract

Base class for PDF417 barcode. More...

Inheritance diagram for APdf417:
ABarcode2D IRectangleCell IBarcode2D IBarcodeItem_2D IPositionRuler IRotation Pdf417Barcode Pdf417Barcode

Public Member Functions

ICellRect GetCellSize ()
 The cell size can be thought of as the width and height of the narrowest bar element within a PDF417 row. More...
 
int GetColumns ()
 The number of columns can be used to limit the width of the barcode. More...
 
String GetData ()
 The barcode content.
 
Pdf417ErrCorrectionEnum GetErrorCorrection ()
 
RotateEnum GetRotation ()
 
int GetRows ()
 The number of rows can be used to limit the height of the barcode. More...
 
IRuler GetRuler ()
 The print resolution can be set in either inch or MM scale. Setting/Updating either scale results in updates to both. More...
 
IPoint GetStart ()
 Position where barcode starts.
 
void SetCellSize (ICellRect cellSize)
 
void SetColumns (int columns)
 
void SetData (String data)
 
void SetErrorCorrection (Pdf417ErrCorrectionEnum errorCorrection)
 
void SetRotation (RotateEnum rotation)
 
void SetRows (int rows)
 
void SetRuler (IRuler ruler)
 
void SetStart (IPoint start)
 
abstract String ToString ()
 Returns the string that can be sent to printer.
 
abstract String toString ()
 

Protected Member Functions

 APdf417 (IPoint start, String data)
 
int LimitRange (int value, int min, int max)
 Utility method to limit values to a specified range. More...
 

Detailed Description

Base class for PDF417 barcode.

Member Function Documentation

◆ GetCellSize()

ICellRect GetCellSize ( )

The cell size can be thought of as the width and height of the narrowest bar element within a PDF417 row.

Changing the dimensions of the smallest element affects the overall width and height of the barcode.

Implements IRectangleCell.

◆ GetColumns()

int GetColumns ( )

The number of columns can be used to limit the width of the barcode.

A zero value indicates that columns are determined automatically. Barcode must be allowed to grow in width or height in order to fit data. For this reason, limiting the growth of the barcode can only be done in one direction either by limiting width or height via Rows or Columns. Note that additional non-data columns result from Start/Stop pattern and the Left/Right row indicators, creating additional 4 columns.

◆ GetRows()

int GetRows ( )

The number of rows can be used to limit the height of the barcode.

A zero value indicates that rows are determined automatically. Barcode must be allowed to grow in width or height in order to fit data. For this reason, limiting the growth of the barcode can only be done in one direction either by limiting width or height via Rows or Columns.

◆ GetRuler()

IRuler GetRuler ( )
inherited

The print resolution can be set in either inch or MM scale. Setting/Updating either scale results in updates to both.

The print resolution must match the resolution of the printer. Incorrect printing will result if a resolution does not match the printer.

Implements IPositionRuler.

◆ LimitRange()

int LimitRange ( int  value,
int  min,
int  max 
)
protected

Utility method to limit values to a specified range.

Parameters
valueThe value to limit.
minThe minimum allowable value.
maxThe maximum allowable value.
Returns
The limited value.