UniPRT SDK v1.0.0.0
 
Loading...
Searching...
No Matches
APdf417 Class Reference

Base class for PDF417 barcode. More...

#include <APdf417.h>

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

Instance Methods

(instancetype- initWithStart:data:
 Initializes a new instance of the APdf417 class with a specified starting point and data.
 
(int- limitRange:minimum:maximum:
 Limits a given value to a specified range.
 
- Instance Methods inherited from ABarcode2D
(NSString *) - NS_REQUIRES_SUPER
 
- Instance Methods inherited from <IBarcode2D>
(NSString *) - description
 Returns the string that can be sent to printer.
 

Properties

id< IPointstart
 The starting point of the PDF417 barcode.
 
NSStringdata
 The data to be encoded in the PDF417 barcode.
 
id< ICellRectcellSize
 The cell size can be thought of as the width and height of the narrowest bar element within a PDF417 row.
 
Pdf417ErrCorrectionEnum errorCorrection
 Error correction level for the PDF417 barcode.
 
int rows
 The number of rows can be used to limit the height of the barcode.
 
int columns
 The number of columns can be used to limit the width of the barcode.
 
- Properties inherited from ABarcode2D
id< IRulerruler
 
id< IPointstart
 
NSString * data
 
RotateEnum rotation
 
- Properties inherited from <IBarcodeItem_2D>
id< IPointstart
 Position where barcode starts.
 
NSString * data
 The barcode content.
 
- Properties inherited from <IPositionRuler>
id< IRulerruler
 
- Properties inherited from <IRotation>
RotateEnum rotation
 
- Properties inherited from <IRectangleCell>
id< ICellRectcellSize
 Barcode cell size. Larger cell size results in barcodes that take up a larger area.
 

Detailed Description

Base class for PDF417 barcode.

Method Documentation

◆ initWithStart:data:

- (instancetype) initWithStart: (id< IPoint >) start
data: (NSString *) data 

Initializes a new instance of the APdf417 class with a specified starting point and data.

Reimplemented in PglPdf417Barcode, and Pdf417Barcode.

◆ limitRange:minimum:maximum:

- (int) limitRange: (int) value
minimum: (int) min
maximum: (int) max 

Limits a given value to a specified range.

Parameters
valueThe value to be limited.
minThe minimum allowable value.
maxThe maximum allowable value.
Returns
The value constrained within the specified range.

Property Documentation

◆ cellSize

- (id<ICellRect>) cellSize
readwritenonatomicstrong

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.

◆ columns

- (int) columns
readwritenonatomicassign

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. This creates additional 4 columns.

◆ data

- (NSString*) data
readwritenonatomicstrong

The data to be encoded in the PDF417 barcode.

◆ errorCorrection

- (Pdf417ErrCorrectionEnum) errorCorrection
readwritenonatomicassign

Error correction level for the PDF417 barcode.

◆ rows

- (int) rows
readwritenonatomicassign

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.

◆ start

- (id<IPoint>) start
readwritenonatomicstrong

The starting point of the PDF417 barcode.


The documentation for this class was generated from the following file: