Select your printer model
Parameters are refined by the selected printer.
addPageArea
Adds page mode print area setting to the command buffer.
Specifies the page mode print area (coordinates). Following this API, call an addText API to specify print data such as the API.
Syntax
- (int) addPageArea:(long)x y:(long)y width:(long)width height:(long)height; |
Parameter
x
Specifies the horizontal origin (in dots).
|
Value |
Description |
|---|---|
|
Integer from 0 to 65535 |
Horizontal origin (in dots) |
"0" specifies the leftmost position of the printable area of the printer.
y
Specifies the vertical origin (in dots).
|
Value |
Description |
|---|---|
|
Integer from 0 to 65535 |
Vertical origin (in dots) |
"0" specifies the position where paper is not fed.
width
Specifies the width of a print area (in dots).
|
Value |
Description |
|---|---|
|
Integer from 1 to 65535 |
Width of a print area (in dots) |
height
Specifies the height of a print area (in dots).
|
Value |
Description |
|---|---|
|
Integer from 1 to 65535 |
Height of a print area (in dots) |
Return value
|
Error status |
Description |
|---|---|
|
EPOS2_SUCCESS |
The function was executed successfully. |
|
EPOS2_ERR_PARAM |
An invalid parameter was passed. |
|
EPOS2_ERR_MEMORY |
Memory necessary for processing could not be allocated. |
|
EPOS2_ERR_FAILURE |
An unknown error occurred. |
Supplementary explanation
- Define the print area in accordance with the contents to print. If the print data does not fit within the print area, the printed contents will be truncated.
- Use this API between the addPageBegin and addPageEnd APIs.
- Specify the width and height of the print area in accordance with the print direction
setting.
Otherwise the print data may be truncated. The print direction is specified by addPageDirection. - This API does not work in the standard mode.
Quick Access
- [Name]
- [Format]
- [Range]
- [Description]
- [Notes]
Epson ePOS SDK includes patented or patent pending functions. The contents must not
be disclosed to third parties.
- Introduction
- help
- Epos2Printer class
- initWithPrinterSeries
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendData
- beginTransaction
- endTransaction
- requestPrintJobStatus
- clearCommandBuffer
- addTextAlign
- addLineSpace
- addTextRotate
- addText
- addTextLang
- addTextFont
- addTextSmooth
- addTextSize
- addTextStyle
- addHPosition
- addFeedUnit
- addFeedLine
- addImage
- addLogo
- addBarcode
- addSymbol
- addHLine
- addVLineBegin
- addVLineEnd
- addPageBegin
- addPageEnd
- addPageArea
- addPageDirection
- addPagePosition
- addPageLine
- addPageRectangle
- addRotateBegin
- addRotateEnd
- addCut
- addPulse
- addSound
- addFeedPosition
- addLayout
- addCommand
- getMaintenanceCounter
- resetMaintenanceCounter
- getPrinterSetting
- setPrinterSetting
- getPrinterSettingEx
- setPrinterSettingEx
- setPrinterSettingEx[Obsolete]
- verifyPassword
- getPrinterInformation
- downloadFirmwareList
- getPrinterFirmwareInfo
- verifyUpdate
- updateFirmware
- forceRecover
- forcePulse
- forceStopSound
- forceCommand
- forceReset
- setStatusChangeEventDelegate
- setReceiveEventDelegate
- setGetPrinterSettingExDelegate
- setSetPrinterSettingExDelegate
- setVerifyPasswordDelegate
- interval
- Epos2LFCPrinter class
- Epos2HybridPrinter class
- initWithLang
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendData
- beginTransaction
- endTransaction
- clearCommandBuffer
- selectPaperType
- waitInsertion
- cancelInsertion
- ejectPaper
- readMicrData
- cleanMicrReader
- forceRecover
- forcePulse
- forceCommand
- forceReset
- paperType
- interval
- waitTime
- mode40Cpl
- setStatusChangeEventDelegate
- setReceiveEventDelegate
- Epos2LineDisplay class
- initWithDisplayModel
- connect
- disconnect
- getStatus
- sendData
- clearCommandBuffer
- addInitialize
- addCreateWindow
- addDestroyWindow
- addSetCurrentWindow
- addClearCurrentWindow
- addCreateScreen
- addCreateScreenCustom
- addCreateTextArea
- addDestroyTextArea
- addSetCurrentTextArea
- addClearCurrentTextArea
- addSetCursorPosition
- addMoveCursorPosition
- addSetCursorType
- addText
- addReverseText
- addMarqueeText
- addSetBlink
- addSetBrightness
- addBackgroundColor
- addStartSlideShow
- addStopSlideShow
- addDownloadImage
- addRegisterDownloadImage
- addNVImage
- addClearImage
- addSymbol
- addClearSymbol
- addShowClock
- addCommand
- setReceiveEventDelegate
- Epos2Keyboard class
- Epos2POSKeyboard class
- Epos2BarcodeScanner class
- Epos2MSR class
- Epos2SimpleSerial class
- Epos2GermanyFiscalElement class
- Epos2OtherPeripheral class
- Epos2CommBox class
- Common to all classes
- Epos2Discovery class
- Epos2Log class
- Epos2BluetoothConnection class
- EasySelect class
- EasySelectInfo class
- Appendix
- Status list
- Key code list
- List of Supported Classes
- List of Supported APIs
- Printer-specific Support Information
- TM-m10
- TM-m30
- TM-m30II
- TM-m30II-H
- TM-m30II-NT
- TM-m30II-S
- TM-m30II-SL
- TM-m30III
- TM-m30III-H
- TM-m50
- TM-m50II
- TM-m50II-H
- TM-T20
- TM-T20II
- TM-T20III
- TM-T20IIIL
- TM-T20X
- TM-T60
- TM-T70
- TM-T70II
- TM-T81II
- TM-T81III
- TM-T82
- TM-T82II
- TM-T82III
- TM-T82IIIL
- TM-T82X
- TM-T83III
- TM-T88V
- TM-T88VI
- TM-T88VII
- TM-T100
- TM-L90 Liner-Free Label Printer Model
- TM-L100
- TM-U220
- TM-U220II
- TM-U330
- TM-P20
- TM-P20II
- TM-P60 (Receipt)
- TM-P60 (Peeler)
- TM-P60II (Receipt)
- TM-P60II (Peeler)
- TM-P80
- TM-P80II
- TM-H6000V
- TM-T20II-i
- TM-T70-i
- TM-T82II-i
- TM-T83II-i
- TM-T88V-i
- TM-T88VI-iHUB
- TM-U220-i
- TM-U220IIB-i
- TM-T70II-DT
- TM-T70II-DT2
- TM-T88V-DT
- TM-T88VI-DT2
- TM-H6000IV-DT
- TM-T88IV
- TM-T90
- TM-L90
- TM-H6000IV
- Usage restriction by firmware version
