BRPtouchPrintInfo

BRPtouchPrintInfo class provides properties to configure print settings.

Properties

strPaperName

The paper kind.

Declaration

@property (nonatomic, copy) NSString *strPaperName;

Constants

RJ, TD series:

Constant Description
@"CUSTOM" Indicates to use a custom paper. You need to set more information via setCustomPaperFile: or setCustomPaperInfoCommand: of BRPtouchPrinter class.

PJ, MW series:

Constant Description
@"A7" A7
@"A6" A6
@"A4" A4
@"A5" A5
@"A5_LANDSCAPE" A5 Landscape
@"LETTER" Letter
@"LEGAL" Legal

QL series:

Constant Description
@"12mm" 12mm continuous length label
@"29mm" 29mm continuous length label
@"38mm" 38mm continuous length label
@"50mm" 50mm continuous length label
@"54mm" 54mm continuous length label
@"62mm" 62mm continuous length label
@"62mmRB" 62mm continuous length label (red and black)
@"102mm" 102mm continuous length label
@"103mm" 103mm continuous length label
@"17mmx54mm" 17mm x 54mm label
@"17mmx87mm" 17mm x 87mm label
@"23mmx23mm" 23mm x 23mm label
@"29mmx42mm" 29mm x 42mm label
@"29mmx90mm" 29mm x 90mm label
@"38mmx90mm" 38mm x 90mm label
@"39mmx48mm" 39mm x 48mm label
@"52mmx29mm" 52mm x 29mm label
@"54mmx29mm" 54mm x 29mm label
@"60mmx86mm" 60mm x 86mm label
@"62mmx29mm" 62mm x 29mm label
@"62mmx100mm" 62mm x 100mm label
@"102mmx51mm" 102mm x 51mm label
@"102mmx152mm" 102mm x 152mm label
@"103mmx164mm" 103mm x 164mm label
@"12mm Dia" 12mm round label
@"24mm Dia" 24mm round label
@"58mm Dia" 58mm round label

PT series:

Constant Description
@"3.5mm" 3.5mm continuous length label
@"6mm" 6mm continuous length label
@"9mm" 9mm continuous length label
@"12mm" 12mm continuous length label
@"18mm" 18mm continuous length label
@"24mm" 24mm continuous length label
@"36mm" 36mm continuous length label
@"HS_5.8mm" 5.8mm heat shrink label
@"HS_8.8mm" 8.8mm heat shrink label
@"HS_11.7mm" 11.7mm heat shrink label
@"HS_17.7mm" 17.7mm heat shrink label
@"HS_23.6mm" 23.6mm heat shrink label
@"FL 21mm x 45mm" 21mm x 45mm flag label
@"PVC Dia 2.5mm" 2.5mm PVC label
@"PVC Dia 3.0mm" 3.0mm PVC label
@"PVC Dia 3.5mm" 3.5mm PVC label
@"PVC Dia 4.0mm" 4.0mm PVC label
@"PVC Dia 5.0mm" 5.0mm PVC label
@"PVC Dia 6.0mm" 6.0mm PVC label
@"PVC Dia 6.5mm" 6.5mm PVC label

nPrintMode

The print scale mode.

Declaration

@property (nonatomic, assign) int nPrintMode;

Constants

Constant Description
PRINT_ORIGINAL No scaling. You need to prepare data less than or equal to the printable area. Refer to the raster command reference for each model to know the area
PRINT_FIT_TO_PAGE Scale data to fit to the printable area
PRINT_FIT_TO_PAPER Scale data to fit to the paper. The part that protrudes from printable area is cut off
PRINT_SCALE Scale data by scaleValue
PRINT_FIT Deprecated. Use PRINT_FIT_TO_PAGE instead

scaleValue

The scale rate used for the case PRINT_SCALE is specified to nPrintMode.

Declaration

@property (nonatomic, assign) double scaleValue;

nDensity

The print density. The range of values depends on printers.

Declaration

@property (nonatomic, assign) int nDensity;

Values

Series Value
PJ 0 to 10
RJ, TD -5 to 5

nOrientation

The paper orientation.

Declaration

@property (nonatomic, assign) int nOrientation;

Constants

Constants Description
ORI_PORTRATE Portrait (default)
ORI_LANDSCAPE Landscape (rotated 90° counterclockwise)

nHalftone

The binarization algorithm.

Declaration

@property (nonatomic, assign) int nHalftone;

Constants

Constants Description
HALFTONE_BINARY Simple binary (default)
HALFTONE_DITHER Dither
HALFTONE_ERRORDIF Error diffusion

nHalftoneBinaryThreshold

The threshold value used for the case HALFTONE_BINARY is specified to nHalftone.

Declaration

@property (nonatomic, assign) int nHalftoneBinaryThreshold;

nHorizontalAlign

The horizontal data alignment. This is effective only if the data width is smaller than the width of the printable area.

Declaration

@property (nonatomic, assign) int nHorizontalAlign;

Constants

Constants Description
ALIGN_LEFT Align left (default)
ALIGN_CENTER Align center
ALIGN_RIGHT Align right

nVerticalAlign

The vertical data alignment. This is effective only if the data height is smaller than the height of the printable area.

Declaration

@property (nonatomic, assign) int nVerticalAlign;

Constants

Constants Description
ALIGN_TOP Align top (default)
ALIGN_MIDDLE Align middle
ALIGN_BOTTOM Align bottom

nPaperAlign

The paper alignment of the custom paper on the printer.

Declaration

@property (nonatomic, assign) int nPaperAlign;

Constants

Constants Description
PAPERALIGN_LEFT Align left (default)
PAPERALIGN_CENTER Align center
PAPERALIGN_RIGHT Align right

nExtFlag

The extra flag for PJ series printer.

Declaration

@property (nonatomic, assign) int nExtFlag;

Constants

These constants can be used not only for PJ673 but also other PJ series.

Constants Description
EXT_PJ673_CARBON Carbon paper is used
EXT_PJ673_DASHPRINT If the EXT_PJ673_EOP is set and roll paper is being used, perforations are printed on each page. (Roll)
EXT_PJ673_NFD The page feed mode is one where feeding is not performed, even if the “new page” command is received. This flag is given priority over EXT_PJ673_EOP and EXT_PJ673_EPR. (Roll)
EXT_PJ673_EOP The page feed mode is one where feeding is performed until the end of page is detected. This flag is given priority over EXT_PJ673_EPR. (Cut sheet)
EXT_PJ673_EPR The page feed mode is one where feeding is performed until the end of page is detected. (Roll with black mark). This is valid only when the paper size is Letter.
EXT_PJ700_FP The page feed mode is one where feeding is performed for the specified paper length. (Roll)

nAutoCutFlag

Whether or not the label should be automatically cut per page.

Declaration

@property (nonatomic, assign) int nAutoCutFlag;

Constants

Constants Description
0 Not cut (default)
OPTION_AUTOCUT Cut

nAutoCutCopies

The page count to cut.

Declaration

@property (nonatomic, assign) int nAutoCutCopies;

bEndCut

Whether or not the label should be automatically cut at the end. (Same meaning as "Chain Print is OFF" for the PT series case)

Declaration

@property (nonatomic, assign) BOOL bEndCut;

bSpecialTape

Whether or not the label is special one not suitable for cutting. Cut option is disabled when this is enabled.

Declaration

@property (nonatomic, assign) BOOL bSpecialTape;

bHalfCut

Whether or not the label should be cut by half.

Declaration

@property (nonatomic, assign) BOOL bHalfCut;

nTopMargin

The top margin by dot. This is effective only if ALIGN_TOP is specified to nVerticalAlign.

Declaration

@property (nonatomic, assign) int nTopMargin;

nLeftMargin

The left margin by dot. This is effective only if ALIGN_LEFT is specified to nHorizontalAlign.

Declaration

@property (nonatomic, assign) int nLeftMargin;

nSpeed

The print speed.

Declaration

@property (nonatomic, assign) int nSpeed;

Constant

Constant Speed
-1 Use Printer Setting
0 high speed
1 medium high speed
2 medium low speed
3 low speed
4 fast draft quality (*1)
5 fast line conversion (*1)
  • (*1) PJ-8xx series only

bBidirection

Whether or not the status should be checked before printing. It will be checked if YES.

Declaration

@property (nonatomic, assign) BOOL bBidirection;

nCustomLength

The custom paper length for PJ series. The length is by dot within range from 200 to 65535. strPaperName need to be @"CUSTOM".

Declaration

@property (nonatomic, assign) int nCustomLength;

nCustomWidth

The custom paper width for PJ series. The width is a multiple of 8 and the maximum value is 2464 dots. strPaperName need to be @"CUSTOM".

Declaration

@property (nonatomic, assign) int nCustomWidth;

nCustomFeed

The feed amount after printing for PJ series. The value is by dot. This is effective when EXT_PJ700_FP is specified to nExtFlag.

Declaration

@property (nonatomic, assign) int nCustomFeed;

strSaveFilePath

The absolute file path to save the print data. The data will be saved into the path without printing if the valid path is specified. The default is nil.

Declaration

@property (nonatomic, assign) NSString *strSaveFilePath;

bOverWrite

Whether or not the print data should be overwritten to the file for the case strSaveFilePath is specified.

Declaration

@property (nonatomic, assign) BOOL bOverWrite;

nRollPrinterCase

The printer case type for PJ series.

Declaration

@property (nonatomic, assign) int nRollPrinterCase;

Constants

Constants Description
PJROLLCASE_OFF No case (default)
PJROLLCASE_ON Use case
PJROLLCASE_WITH_ANTICURL Use case with anti-curl
PJROLLCASE_SHORT_FEED Set short feed mode
PJROLLCASE_KEEP_PRINTER_SETTING Keep printer setting

bRotate180

Whether or not the print data should be rotated by 180 degrees. The default is NO.

Declaration

@property (nonatomic, assign) BOOL bRotate180;

bPeel

Whether or not the peeling mode should be enabled.

Declaration

@property (nonatomic, assign) BOOL bPeel;

nLabelMargine

The additional margin to the minimum margin.

Declaration

@property (assign,nonatomic)int nLabelMargine;

nPJPaperKind;

Declaration

@property (assign,nonatomic)int nPJPaperKind;

Constants

Constants Description
PJ_ROLL Roll paper
PJ_CUT_PAPER Cut paper

nPrintQuality

The print quality options for PT, QL and TD series. This property is ignored if HS (heat-shrink) or Tube label is set.

Declaration

@property (nonatomic, assign) int nPrintQuality;

Constants

Constant Description
PRINTQUALITY_LOW_RESOLUTION Prints with the half resolution in the print direction.
PRINTQUALITY_NORMAL Normal.
PRINTQUALITY_DOUBLE_SPEED Resolution without changing performs printing by raising the printing speed.
PRINTQUALITY_HIGH_RESOLUTION Prints with the double resolution in the print direction.
PRINTQUALITY_HIGH_RESOLUTION_USING_HR_IMAGE Prints with the double resolution in the print direction. Images that have double resolution in the print direction are required.

Supported printers for each enumerator are as below.

Enumerator Supported Printer
LOW_RESOLUTION PT-E850TKW, PT-D800W, PT-E800W, PT-P900W, PT-P950NW
NORMAL QL series, PT series, TD series
DOUBLE_SPEED QL series, TD series
HIGH_RESOLUTION QL series (other than QL-11xx series), PT series
PRINTQUALITY_HIGH_RESOLUTION_USING_HR_IMAGE QL series (QL-7xx/QL-8xx series)
PT series (PT-D800W/PT-E800W/PT-E550W/PT-P750NW/PT-P9xx series)

nForceStretchPrintableArea

Extend the printing area in the bottom direction. Default is 0. Negative values cannot be set. If you use this property, the bottom part of the document may not be printed.

Declaration

@property   (assign,nonatomic)int       nForceStretchPrintableArea;

bMode9

Whether or not to compress print data with Mode9. This has priority if both this and bRawMode is YES.

Declaration

@property (nonatomic, assign) BOOL bMode9;

bRawMode;

Whether or not to compress print data.

Declaration

@property (assign,nonatomic)BOOL bRawMode;

Declaration

@property (assign,nonatomic)BOOL bBanishMargin;

bUseLegacyHalftoneEngine;

If YES, images and PDFs are rasterized with legacy halftone engine. Default is NO.

Warning

Generally, set NO or nothing. It is intended for specific use only.

Declaration

@property (assign,nonatomic)BOOL bUseLegacyHalftoneEngine;

bUseCopyCommandInTemplatePrint;

If YES, printing templates can be expected to be faster when printing multiple copies of the same template.

Declaration

@property (assign,nonatomic)BOOL bUseCopyCommandInTemplatePrint;

bWaitCompletionOfSendingDataAndFile;

If YES, wait completion of sending data with sendData: by getting the printer status. Default is NO.

Declaration

@property (assign,nonatomic)BOOL bWaitCompletionOfSendingDataAndFile;

Notes

Property Compatibility

Some properties of BRPtouchPrintInfo are supported only by specific printers. Refer to the compatibility table.

nBiColorRedEnhancement

The property for QL-8xx series. Enhancement red color. Value range is from -20 to 20. Default value is 0.
This value is effective when paper name is @"62mmRB".

Declaration

@property   (assign,nonatomic)int       nBiColorRedEnhancement;

nBiColorGreenEnhancement

The property for QL-8xx series. Enhancement green color. Value range is from -20 to 20. Default value is 0.
This value is effective when paper name is @"62mmRB".

Declaration

@property   (assign,nonatomic)int       nBiColorGreenEnhancement;

nBiColorBlueEnhancement

The property for QL-8xx series. Enhancement blue color. Value range is from -20 to 20. Default value is 0.
This value is effective when paper name is @"62mmRB".

Declaration

@property   (assign,nonatomic)int       nBiColorBlueEnhancement;

Deprecates

bBanishMargin

Deprecated