UniPRT SDK  v1.0.0.0
UniPRT.Sdk.LabelMaker.Interfaces Namespace Reference

Classes

class  AAztecBarcode
 Base class for Aztec 2D barcode. More...
 
class  ABarcode1D
 
class  ABarcode2D
 
class  ABarcodeItem
 
class  ABarWidths
 
class  ACellSquare
 
class  ADataMatrix
 Base class for DataMatrix 2D barcode with ECC 200 error correction. More...
 
class  ALine
 
class  AMaxicodeBarcode
 
class  AMaxicodeMsg
 This is for modes with free form message. Does not apply to Mode 2 or 3. More...
 
class  AMaxicodeMsgStructured
 This only applies for Mode 2 or 3. More...
 
class  AMaxicodeMsgStructuredOpenSystemStandard
 This only applies for Mode 2 or 3. More...
 
class  APair
 
class  APdf417
 Base class for PDF417 barcode. More...
 
class  AQRBarcode
 Base class for QR Code 2D barcode. More...
 
class  ARfidWrite
 
class  AText
 
class  ATextItem
 
class  BarcodeItem
 
class  CellRect
 
class  CellSquare
 
class  Defaults
 The defaults used for settings if not specified during object creation or set/changed. More...
 
class  FontSize
 Font size in the X and Y direction allows for stretching/resizing when non-default font size is desired. More...
 
interface  IAlignment
 The alignment of an object within the plane. More...
 
interface  IBarcode1D
 
interface  IBarcode2D
 
interface  IBarcode_1D_Properties
 
interface  IBarcodeItem
 Specify barcode content and position on plane where barcode starts. More...
 
interface  IBarcodeItem_2D
 Barcodes types for 2D barcodes ‍/ public enum BarcodeTypeEnum_2D { NOT_DEFINED, // for case where need to enforce initialization MAXICODE, QR, PDF417, AZTEC, DATAMATRIX }. More...
 
interface  IBarcodeType1D
 
interface  IBarWidths
 Sets the Narrow/Wide bar widths. More...
 
interface  IBox
 
interface  ICellRect
 Sets the size of the single cell rectangle of a 2D barcode. More...
 
interface  ICellSquare
 Sets the size of the single cell of a 2D barcode. ‍/ public interface ICellSize { /**. More...
 
interface  IFont
 
interface  IFontSettings
 
interface  IFontSize
 Pair for font scaling/resizing. More...
 
interface  IFontSizeUnits
 
interface  IFontStyle
 
interface  ILabel
 Label is the container for other objects that are printed. More...
 
interface  ILine
 
interface  IMaxicodeBarcode
 
interface  IMaxicodeData
 Interface for objects that contain Maxicode barcode data. More...
 
interface  IMaxicodeMsg
 Maxicode barcode data. Does not apply to Mode 2 or 3. More...
 
interface  IMaxicodeMsgStructured
 Maxicode barcode data. Maxicode Free Form carrier message. Only applies to Mode 2 and 3. More...
 
interface  IMaxicodeMsgStructuredOpenSystemStandard
 Maxicode barcode data. Maxicode Open System Standard carrier message. Only applies to Mode 2 and 3. More...
 
interface  IPair
 Pair that can be for any 2D plane relationship or other use. More...
 
interface  IPoint
 Coordinate pair within a 2D plane. More...
 
interface  IPositionRuler
 
interface  IPrintResolution
 The print resolution can be set in either inch or MM scale. Setting/Updating either scale results in updates to both. More...
 
interface  IRectangleCell
 
interface  IRfidBankSelect
 
interface  IRfidBitField
 
interface  IRfidPassword
 For cases where memory access is password protected. More...
 
interface  IRfidWrite
 Write to different areas or memory blocks of an RFID tag. More...
 
interface  IRotation
 The rotation of an object. More...
 
interface  IRuler
 The units and resolution used for object placement within a plane. More...
 
interface  ISquareCell
 
interface  IText
 
interface  ITextItem
 Specify text and position on plane where text starts. More...
 
interface  ITextSettings
 
class  Point
 
class  PrintResolution
 
class  RfidConvert
 Support methods to help convert non-byte data to order stored in RFID tags. More...
 
class  Ruler
 
class  TextItem
 

Enumerations

enum  AlignEnum { AlignEnum.Default, AlignEnum.Left, AlignEnum.Center, AlignEnum.Right }
 Alignment options of object within a plane. More...
 
enum  AztecCodeTypeEnum {
  AztecCodeTypeEnum.Default, AztecCodeTypeEnum.FixedErrCorrection, AztecCodeTypeEnum.Compact, AztecCodeTypeEnum.Full,
  AztecCodeTypeEnum.Rune
}
 Aztec barcode type/formats. More...
 
enum  BarcodeTypeEnum_1D {
  NOT_DEFINED, Code_93, Code_39, Code_128,
  EAN13, EAN8, UPCA, I2of5,
  CODABAR
}
 Barcode types for 1D barcodes.
 
enum  FontSizeUnitsEnum { FontSizeUnitsEnum.Ruler, FontSizeUnitsEnum.Points, FontSizeUnitsEnum.Percent }
 Select the font size units for font resizing. More...
 
enum  FontStyleEnum { FontStyleEnum.Normal = 0, FontStyleEnum.Bold = 1, FontStyleEnum.Italic = 2 }
 This enumeration supports bitwise operation of member values. More...
 
enum  MaxicodeModeEnum { MaxicodeModeEnum.MODE_2 = 2, MaxicodeModeEnum.MODE_3 = 3, MaxicodeModeEnum.MODE_4 = 4 }
 Maxicode modes. More...
 
enum  Pdf417ErrCorrectionEnum {
  Pdf417ErrCorrectionEnum.LEVEL_0 = 0, LEVEL_1, LEVEL_2, LEVEL_3,
  LEVEL_4, LEVEL_5, LEVEL_6, LEVEL_7,
  Pdf417ErrCorrectionEnum.LEVEL_8
}
 The error correction, also known as security level, allows for barcodes with damage to still be readable. More...
 
enum  QRCodeErrorCorrectionEnum { QRCodeErrorCorrectionEnum.EC_7, QRCodeErrorCorrectionEnum.EC_15, QRCodeErrorCorrectionEnum.EC_25, QRCodeErrorCorrectionEnum.EC_30 }
 Error correction allows for barcodes to remain readable if damaged but increases the amount of data encoded. More...
 
enum  QRCodeManualEncodingEnum { QRCodeManualEncodingEnum.Numeric, QRCodeManualEncodingEnum.AlphaNumeric, QRCodeManualEncodingEnum.Binary, QRCodeManualEncodingEnum.Kanji }
 QR Code data can be stored using different encoding types which affect the storage capacity of the barcode. More...
 
enum  QRCodeMaskEnum {
  Mask_0 = 0, Mask_1, Mask_2, Mask_3,
  Mask_4, Mask_5, Mask_6, Mask_7,
  Mask_8
}
 The QR Mask changes the QR barcode generated by changing the distribution of light and dark cells. More...
 
enum  QRCodeModelEnum { MODEL_1, MODEL_2 }
 QR barcodes have increased in capacity and readability. Model 1 is the original and other models improve readability and data capacity.
 
enum  RfidMemBlockEnum {
  RfidMemBlockEnum.InvalidMemBlock, RfidMemBlockEnum.EPC, RfidMemBlockEnum.TID, RfidMemBlockEnum.User,
  RfidMemBlockEnum.AccessCode, RfidMemBlockEnum.KillCode, RfidMemBlockEnum.PC, RfidMemBlockEnum.Reserve
}
 RFID memory block selection. More...
 
enum  RfidPasswordTypeEnum {
  RfidPasswordTypeEnum.None, RfidPasswordTypeEnum.Lock, RfidPasswordTypeEnum.PermaLock, RfidPasswordTypeEnum.Unlock,
  RfidPasswordTypeEnum.PermaUnlock
}
 RFID format parameter for denoting string type. More...
 
enum  RotateEnum { RotateEnum.None, RotateEnum.ClockWise, RotateEnum.CounterClockWise, RotateEnum.Inverted }
 Direction/Rotation for objects commands that support rotation. More...
 
enum  ScaleEnum { ScaleEnum.Dot, ScaleEnum.MM, ScaleEnum.Inch }
 Scale types for object placement within a plane. More...
 

Enumeration Type Documentation

◆ AlignEnum

Alignment options of object within a plane.

Enumerator
Default 

Default align.

Left 

Left align.

Center 

Center align.

Right 

Right align.

◆ AztecCodeTypeEnum

Aztec barcode type/formats.

Enumerator
Default 

Uses default error correction level of 23% + 3 codewords.

FixedErrCorrection 

User specified error correction level from 1 to 99.

Compact 

Compact format barcode. Allows 1 - 4 layers. Core, center finder pattern, has 2 black squares in addition to center square.

Full 

Full format barcode. Allows 1 - 32 layers. Core, center finder pattern, has 3 black squares in addition to center square.

Rune 

Typically used to encode one byte of data represented as decimal range 0-255.

◆ FontSizeUnitsEnum

Select the font size units for font resizing.

Enumerator
Ruler 

Use the units of the ruler. Ruler units are converted to font points (1/72 inch, ~0.35 mm).

Points 

Use font point. 1 point = 1/72 inch (~0.35 mm).

Percent 

0-100 percent expansion/multiplier scaling. 0 or 1 specifies standard font, no scaling. 100% for maximum expansion/multiplier.

◆ FontStyleEnum

This enumeration supports bitwise operation of member values.

Enumerator
Normal 

Default/normal text.

Bold 

Bold text.

Italic 

Italic text.

◆ MaxicodeModeEnum

Maxicode modes.

Maxicode barcodes have two main message structures referred to as Primary Message and Secondary Message. The mode determines the content of the message structures and the Error Correction (EEC = Enhanced Error Correction, SEC = Standard Error Correction).
Since each message section, Primary Message or Secondary Message, can have different levels of error correction, the data to be encoded into the Maxicode barcode is divided into message sections depending on the mode.
Modes 2 & 3:

  • Specific format for the Primary Message that requires:
    • postal code (6-9 chars)
    • country code (3 char numeric)
    • service class (3 char numeric)
  • Secondary Message can be Free Format and is dependent on the application. i.e. UPS Shipping requires specific fields and field separators.
Enumerator
MODE_2 

Structured Carrier Message: 6-9 chars postal code (numeric)

MODE_3 

Structured Carrier Message: 6 chars postal code (alphanumeric)

MODE_4 

Standard Symbol. Unstructured data, general-use barcode. EEC Primary Message, SEC Secondary Message.

◆ Pdf417ErrCorrectionEnum

The error correction, also known as security level, allows for barcodes with damage to still be readable.

Higher error correction allows for barcode to be readable with higher damage.
Note that higher error correction adds more data to the barcode.

Enumerator
LEVEL_0 

Lowest level of error correction.

LEVEL_8 

Highest level of error correction.

◆ QRCodeErrorCorrectionEnum

Error correction allows for barcodes to remain readable if damaged but increases the amount of data encoded.

Higher error correction allows for more damage to the barcode while still being readable.
The barcode size/area increases with higher error correction due to use of more data on higher error correction levels.

Enumerator
EC_7 

7% Error Correction. Also known as 'L' level.

EC_15 

15% Error Correction. Also known as 'M' level.

EC_25 

25% Error Correction. Also known as 'Q' level.

EC_30 

30% Error Correction. Also known as 'H' level.

◆ QRCodeManualEncodingEnum

QR Code data can be stored using different encoding types which affect the storage capacity of the barcode.

In order to optimize barcode data capacity, it may sometimes be desirable to manually encode different data types to match the type of data being stored in the QR Barcode. For example, Numeric data (numbers only) can be stored more efficiently than other data types and if there is a long string of numbers, it may be more efficient to store the data in Numeric format.

Enumerator
Numeric 

Numbers only.

AlphaNumeric 

Numbers and letters.

Binary 

Byte/binary.

Kanji 

Kanji Data.

◆ QRCodeMaskEnum

The QR Mask changes the QR barcode generated by changing the distribution of light and dark cells.

Using different masks may result in making the QR Code easier to read by a barcode scanner.

◆ RfidMemBlockEnum

RFID memory block selection.

Enumerator
InvalidMemBlock 

For case where need to enforce initialization.

EPC 

Electronic Product Code.

TID 

Tag Identification. This is typically a read only field.

User 

User memory.

AccessCode 

Access code. Typically 4 bytes.

KillCode 

Kill code. Typically 4 bytes.

PC 

Protocol Control Word (16 bits) (Gen 2 tags only)

Reserve 

Reserved memory.

◆ RfidPasswordTypeEnum

RFID format parameter for denoting string type.

Although all data is a string. The limiting factor is the characters within the string based on the data format.
Examples:

  • Binary: "0101"
  • Hex: "AF29CD5E"
  • Decimal: "1975"
  • String: "June 15, 1215"

Passwords for accessing/securing memory areas on tags that support this feature.

Enumerator
None 

No password.

Lock 

Lock. Allows for modificiation of data in future if correct password provided.

PermaLock 

Permanently lock. Prevents further modification of data.

Unlock 

Unlock block so that it can be overwritten.

PermaUnlock 

Permanently unlock. Cannot be locked.

◆ RotateEnum

Direction/Rotation for objects commands that support rotation.

Enumerator
None 

No rotation.

ClockWise 

90 Degrees clockwise rotation

CounterClockWise 

90 Degrees counter clockwise rotation. 270 Degrees clockwise rotation

Inverted 

180 Degrees clockwise rotation

◆ ScaleEnum

Scale types for object placement within a plane.

Enumerator
Dot 

Dot scale.

MM 

Millimeter scale.

Inch 

Inch scale.