UniPRT SDK v1.0.0.0-pyd (Python)
 
Loading...
Searching...
No Matches
LabelMakerSDK.LabelMakerSDK Class Reference

Public Member Functions

 __init__ (self)
 
 CreateLabel (self, iPrintLanguageTyp, LabelName, dotsPerUnit, unit)
 Create a label.
 
 CreateTexts (self, x_start, y_start, fontsize_x, fontsize_y, data, scale, FontSizeUnit, FontStyle, Alignment, fontName, rotation)
 Create texts in a Label.
 
 CreateBarcode1D (self, start_x, start_y, content, scale, narrowBar, wideBar, Height, BcdTyp, PrintHumanReadable, rotation, PdfLocTop)
 Create barcode 1D in a Label.
 
 CreateLines (self, start_x, start_y, end_x, end_y, lineThickness, scale)
 Create lines in a Label.
 
 CreateBoxs (self, start_x, start_y, end_x, end_y, lineThickness, scale)
 Create boxes in a Label.
 
 CreateMaxicodeBarcodes (self, iMaxicodeTyp, mode, postalCode, countryCode, serviceClass, remainingMsg, year, primaryMsg, start_x, start_y, scale, ZipperPattern, rotation)
 Create Maxicode barcodes in a Label.
 
 CreatePdf417Bcodes (self, start_x, start_y, content, scale, xdim, ydim, ErrorCorrection, row, col, rotation)
 Create PDF417 barcodes in a Label.
 
 CreateAztecBarcodes (self, start_x, start_y, content, scale, xdim, CodeType, iFixedErrCorrection, iLayers, rotation)
 Create aztec barcodes in a Label.
 
 CreateDataMatrixBarcodes (self, start_x, start_y, content, scale, xdim, Rotation, UseRectangle, MatrixMultiLine, CtrlChar1, CtrlChar2, row, col)
 Create data matrix barcodes in a Label.
 
 CreateQRBarcodes (self, start_x, start_y, content, scale, xdim, Mask, dataManuallyEncoded, errEnum, modelEnum, rotation)
 Create data QR barcodes in a Label.
 
 ToHexString (self, input_str)
 
 CreateRfidEncode (self, a32BitField, a16BitField, a6CharAsciiString, MemBlock, iOffsetFromStart, _10BytesUserData, _4BytesHexUserData, PasswordEnum, Password)
 Create RFID in a Label.
 
 LabelToString (self, str)
 Create a label with TSPL or PGL.
 
 CloseLabel (self)
 Release a resource.
 

Public Attributes

 gpLabel
 
 gpTextType
 
 gpMexiCodeBarcodeType
 
 gpPdf417BarcodeType
 
 gpDataMatrixBarcodeType
 
 gpAztecBarcodeType
 
 gpQRBarcodeType
 
 gpRfidWriteType
 
 gpLineType
 
 gpBoxType
 
 gpBarcode1DType
 
 gpPrinterResolution
 
 gpRuler
 
 gpCellRect
 
 gpCellSquare
 
 ObjectsPtr
 
 ObjRulerPtr
 
 ObjStartPtr
 
 ObjEndPtr
 
 ObjCellSquarePtr
 
 ObjCellRectPtr
 
 ObjTextItemPtr
 
 giPrintLanguageTyp
 

Constructor & Destructor Documentation

◆ __init__()

LabelMakerSDK.LabelMakerSDK.__init__ ( self)

Member Function Documentation

◆ CloseLabel()

LabelMakerSDK.LabelMakerSDK.CloseLabel ( self)

Release a resource.

Returns
None
Sample
CloseLabel()

◆ CreateAztecBarcodes()

LabelMakerSDK.LabelMakerSDK.CreateAztecBarcodes ( self,
start_x,
start_y,
content,
scale,
xdim,
CodeType,
iFixedErrCorrection,
iLayers,
rotation )

Create aztec barcodes in a Label.

Parameters
[in]start_xstart point for x coordinate
[in]start_ystart point for y coordinate
[in]contentaztec content
[in]scaleset a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
[in]xdimset a cellsize for x coordinate
[in]CodeTypeset a code type (e.g. AztecCodeTypeEnum.Compact)
[in]iFixedErrCorrectionset the FixedErrCorrection (e.g. AztecCodeTypeEnum.FixedErrCorrection)
[in]iLayersset the layers
[in]rotationset a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)
Returns
None
Sample
CreateAztecBarcodes(0.25, 2.25, "Mr. AirTraveler, seat A, flight 200", ScaleEnum.Inch, 0.025, AztecCodeTypeEnum.Compact, NON_USED, 4, RotateEnum.None)

◆ CreateBarcode1D()

LabelMakerSDK.LabelMakerSDK.CreateBarcode1D ( self,
start_x,
start_y,
content,
scale,
narrowBar,
wideBar,
Height,
BcdTyp,
PrintHumanReadable,
rotation,
PdfLocTop )

Create barcode 1D in a Label.

Parameters
[in]start_xstart point for x coordinate
[in]start_ystart point for y coordinate
[in]contentbarcode 1D content
[in]scaleset a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
[in]narrowBartext content
[in]wideBarset a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
[in]Heightset a font size unit (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
[in]BcdTypset a barcode type (e.g. BarcodeTypeEnum_1D.Code_128)
[in]PrintHumanReadablea flag to set PrintHumanReadable
[in]rotationset a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)
[in]PdfLocTopset a flag to print human-readable data above the barcode. (Default value is below)
Returns
None
Sample
CreateBarcode1D(0.5, 1.0 + 1.5 + 1 / 4 + 1.2, "Code 128", ScaleEnum.Inch, 0.015, 0.015 * 4.1, 1.2, BarcodeTypeEnum_1D.Code_128,
True, RotateEnum.None, False)

◆ CreateBoxs()

LabelMakerSDK.LabelMakerSDK.CreateBoxs ( self,
start_x,
start_y,
end_x,
end_y,
lineThickness,
scale )

Create boxes in a Label.

start_x: start point for x coordinate

start_y: start point for y coordinate

end_x: end point for x coordinate

end_y: end point for y coordinate

lineThickness: set a lineThickness

scale: set a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)

Returns
None
Sample
CreateBoxs(0.5, 1.25, 3.5, 2.25, 1/16, ScaleEnum.Inch)

◆ CreateDataMatrixBarcodes()

LabelMakerSDK.LabelMakerSDK.CreateDataMatrixBarcodes ( self,
start_x,
start_y,
content,
scale,
xdim,
Rotation,
UseRectangle,
MatrixMultiLine,
CtrlChar1,
CtrlChar2,
row,
col )

Create data matrix barcodes in a Label.

Parameters
[in]start_xstart point for x coordinate
[in]start_ystart point for y coordinate
[in]contentdata matrix content
[in]scaleset a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
[in]xdimset a cellsize for x coordinate
[in]Rotationset a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)
[in]UseRectangleset a flag to use rectangle
[in]MatrixMultiLineset a multiline string
[in]CtrlChar1set a CtrlChar1
[in]CtrlChar2set a CtrlChar2
[in]rowset the number of rows can be used to limit the height of the barcode.
[in]colset the number of columns can be used to limit the width of the barcode.
Returns
None
Sample
CreateDataMatrixBarcodes(2.25, 0.25, "Line 1 DataMatrix", ScaleEnum.Inch, NON_USED, RotateEnum.None, False, "Line 2 content/r/nLine 3 content", 0x0D, 0x0A, 0, 0)

◆ CreateLabel()

LabelMakerSDK.LabelMakerSDK.CreateLabel ( self,
iPrintLanguageTyp,
LabelName,
dotsPerUnit,
unit )

Create a label.

Parameters
[in]iPrintLanguageTypselect TSPL or PGL
[in]LabelNameset a label name
[in]dotsPerUnitset DPI (203/300/600)
[in]unitset unit (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
Returns
None
Sample
CreateLabel(TSPL, "SimpleLabel", 300, ScaleEnum.Inch)

◆ CreateLines()

LabelMakerSDK.LabelMakerSDK.CreateLines ( self,
start_x,
start_y,
end_x,
end_y,
lineThickness,
scale )

Create lines in a Label.

Parameters
[in]start_xstart point for x coordinate
[in]start_ystart point for y coordinate
[in]end_xend point for x coordinate
[in]end_yend point for y coordinate
[in]lineThicknessset a lineThickness
[in]scaleset a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
Returns
None
Sample
CreateLines(2.5, 1/16, 2.5, 1.0, 1/32, ScaleEnum.Inch)

◆ CreateMaxicodeBarcodes()

LabelMakerSDK.LabelMakerSDK.CreateMaxicodeBarcodes ( self,
iMaxicodeTyp,
mode,
postalCode,
countryCode,
serviceClass,
remainingMsg,
year,
primaryMsg,
start_x,
start_y,
scale,
ZipperPattern,
rotation )

Create Maxicode barcodes in a Label.

Parameters
[in]iMaxicodeTypselect a maxicode type (e.g. _MaxicodeMsgStructured)
[in]modeset a maxicode (e.g. MaxicodeModeEnum.MODE_2)
[in]postalCodeset a postal code string
[in]countryCodeset a country code string
[in]serviceClassset a service class string
[in]remainingMsgset a remaining message string
[in]yearset a year string
[in]primaryMsgset a primary message string
[in]start_xstart point for x coordinate
[in]start_ystart point for y coordinate
[in]scaleset a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
[in]ZipperPatternset a flag for zipper pattern or not
[in]rotationset a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)
Returns
None
Sample
CreateMaxicodeBarcodes(_MaxicodeMsgStructured, MaxicodeModeEnum.MODE_2, "902557317", "800", "200", "Maxicode Carrier Standard", "", "", 0.5, 0.5, ScaleEnum.Inch, False, RotateEnum.None)

◆ CreatePdf417Bcodes()

LabelMakerSDK.LabelMakerSDK.CreatePdf417Bcodes ( self,
start_x,
start_y,
content,
scale,
xdim,
ydim,
ErrorCorrection,
row,
col,
rotation )

Create PDF417 barcodes in a Label.

Parameters
[in]start_xstart point for x coordinate
[in]start_ystart point for y coordinate
[in]contentPDF417 content
[in]scaleset a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
[in]xdimset a cellsize for x coordinate
[in]ydimset a cellsize for y coordinate
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.
[in]ErrorCorrectionset a error correction (e.g. Pdf417ErrCorrectionEnum.LEVEL_5)
[in]rowset the number of rows can be used to limit the height of the barcode.
[in]colset the number of columns can be used to limit the width of the barcode.
[in]rotationset a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)
Returns
None
Sample
CreatePdf417Bcodes(0.25, 2.0, someShortText, ScaleEnum.Inch, 0.015, 0.05, Pdf417ErrCorrectionEnum.LEVEL_5, NON_USED, NON_USED, RotateEnum.None)

◆ CreateQRBarcodes()

LabelMakerSDK.LabelMakerSDK.CreateQRBarcodes ( self,
start_x,
start_y,
content,
scale,
xdim,
Mask,
dataManuallyEncoded,
errEnum,
modelEnum,
rotation )

Create data QR barcodes in a Label.

Parameters
[in]start_xstart point for x coordinate
[in]start_ystart point for y coordinate
[in]contentQR content
[in]scaleset a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
[in]xdimset a cellsize for x coordinate
[in]Maskset a mask (e.g. QRCodeMaskEnum.Mask_4)
[in]dataManuallyEncodedset a dataManuallyEncoded
[in]errEnumset an error enum (e.g. QRCodeErrorCorrectionEnum.EC_15)
[in]modelEnumset a model enum (e.g. QRCodeModelEnumz.MODEL_1)
[in]rotationset a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)
Returns
None
Sample
CreateQRBarcodes(1.75, 3.75, "", ScaleEnum.Inch, 0.025, QRCodeMaskEnum.Mask_4, dataManuallyEncoded,
QRCodeErrorCorrectionEnum.NON_USED, QRCodeModelEnum.NON_USED, RotateEnum.None)

◆ CreateRfidEncode()

LabelMakerSDK.LabelMakerSDK.CreateRfidEncode ( self,
a32BitField,
a16BitField,
a6CharAsciiString,
MemBlock,
iOffsetFromStart,
_10BytesUserData,
_4BytesHexUserData,
PasswordEnum,
Password )

Create RFID in a Label.

Parameters
[in]a32BitFieldset RFID 32 bit field
[in]a16BitFieldset RFID 16 bit field
[in]a6CharAsciiStringset RFID 6 characters ASCII string
[in]MemBlockset a memory block (e.g. RfidMemBlockEnum.EPC)
[in]iOffsetFromStartset an offset from start
[in]_10BytesUserDataset a RFID 10 bytes string
[in]_4BytesHexUserDataset a RFID 4 bytes string
[in]PasswordEnumset a password enum (e.g. RfidPasswordTypeEnum.Lock)
[in]Passwordset a password string
Returns
None
Sample
CreateRfidEncode(a32BitField, a16BitField, a6CharAsciiString, RfidMemBlockEnum.User, 2, "MyUserData", "0ABCDE0F", RfidPasswordTypeEnum.None, "")
Here is the call graph for this function:

◆ CreateTexts()

LabelMakerSDK.LabelMakerSDK.CreateTexts ( self,
x_start,
y_start,
fontsize_x,
fontsize_y,
data,
scale,
FontSizeUnit,
FontStyle,
Alignment,
fontName,
rotation )

Create texts in a Label.

Parameters
[in]x_startstart point for x coordinate
[in]y_startstart point for y coordinate
[in]fontsize_xfont size for x coordinate
[in]fontsize_yfont size for y coordinate
[in]datatext content
[in]scaleset a scale (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
[in]FontSizeUnitset a font size unit (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
[in]FontStyleset a font style (FontSizeUnitsEnum.Ruler/FontSizeUnitsEnum.Points/FontSizeUnitsEnum.Percent)
[in]Alignmentset a alignment for text (ScaleEnum.Dot/ScaleEnum.MM/ScaleEnum.Inch)
[in]fontNameset font name
[in]rotationset a rotation (RotateEnum.None/RotateEnum.ClockWise/RotateEnum.CounterClockWise/RotateEnum.Inverted)
Returns
None
Sample
CreateTexts(2.0, 1.25 + 7 / 16, 3 / 16, 7 / 16, "MY MAGIC", ScaleEnum.Inch, FontSizeUnitsEnum.Ruler,
(FontStyleEnum)NON_USED, AlignEnum.Center, "93952.sf", RotateEnum.None)

◆ LabelToString()

LabelMakerSDK.LabelMakerSDK.LabelToString ( self,
str )

Create a label with TSPL or PGL.

Parameters
[out]strTSPL or PGL strings
Returns
None
Sample
LabelToString(LabelString)

◆ ToHexString()

LabelMakerSDK.LabelMakerSDK.ToHexString ( self,
input_str )
Here is the caller graph for this function:

Member Data Documentation

◆ giPrintLanguageTyp

LabelMakerSDK.LabelMakerSDK.giPrintLanguageTyp

◆ gpAztecBarcodeType

LabelMakerSDK.LabelMakerSDK.gpAztecBarcodeType

◆ gpBarcode1DType

LabelMakerSDK.LabelMakerSDK.gpBarcode1DType

◆ gpBoxType

LabelMakerSDK.LabelMakerSDK.gpBoxType

◆ gpCellRect

LabelMakerSDK.LabelMakerSDK.gpCellRect

◆ gpCellSquare

LabelMakerSDK.LabelMakerSDK.gpCellSquare

◆ gpDataMatrixBarcodeType

LabelMakerSDK.LabelMakerSDK.gpDataMatrixBarcodeType

◆ gpLabel

LabelMakerSDK.LabelMakerSDK.gpLabel

◆ gpLineType

LabelMakerSDK.LabelMakerSDK.gpLineType

◆ gpMexiCodeBarcodeType

LabelMakerSDK.LabelMakerSDK.gpMexiCodeBarcodeType

◆ gpPdf417BarcodeType

LabelMakerSDK.LabelMakerSDK.gpPdf417BarcodeType

◆ gpPrinterResolution

LabelMakerSDK.LabelMakerSDK.gpPrinterResolution

◆ gpQRBarcodeType

LabelMakerSDK.LabelMakerSDK.gpQRBarcodeType

◆ gpRfidWriteType

LabelMakerSDK.LabelMakerSDK.gpRfidWriteType

◆ gpRuler

LabelMakerSDK.LabelMakerSDK.gpRuler

◆ gpTextType

LabelMakerSDK.LabelMakerSDK.gpTextType

◆ ObjCellRectPtr

LabelMakerSDK.LabelMakerSDK.ObjCellRectPtr

◆ ObjCellSquarePtr

LabelMakerSDK.LabelMakerSDK.ObjCellSquarePtr

◆ ObjectsPtr

LabelMakerSDK.LabelMakerSDK.ObjectsPtr

◆ ObjEndPtr

LabelMakerSDK.LabelMakerSDK.ObjEndPtr

◆ ObjRulerPtr

LabelMakerSDK.LabelMakerSDK.ObjRulerPtr

◆ ObjStartPtr

LabelMakerSDK.LabelMakerSDK.ObjStartPtr

◆ ObjTextItemPtr

LabelMakerSDK.LabelMakerSDK.ObjTextItemPtr