Select your printer model
addBackgroundColor
Adds the specification of the background color to the command buffer.
The background color from the beginning till the end of the row specified in the text area can be changed.
Syntax
- (int) addBackgroundColor:(int)row r:(long)r g:(long)g b:(long)b; |
Parameter
row
Specifies the row to which the background color is applied.
Value |
Description |
---|---|
Integer from 1 to 19 |
Changes the background color of the specified row. |
EPOS2_EVEN_ROWS |
Changes the background color of all even rows. |
EPOS2_ODD_ROWS |
Changes the background color of all odd rows. |
EPOS2_ALL_ROWS |
Changes the background color of all rows. |
r
Specifies the red color value of the background color.
Value |
Description |
---|---|
Integer from 0 to 255 |
Red color value |
g
Specifies the green color value of the background color.
Value |
Description |
---|---|
Integer from 0 to 255 |
Green color value |
b
Specifies the blue color value of the background color.
Value |
Description |
---|---|
Integer from 0 to 255 |
Blue color value |
Return value
Error status |
Description |
---|---|
EPOS2_SUCCESS |
The function was executed successfully. |
EPOS2_ERR_PARAM |
An invalid parameter was passed. |
EPOS2_ERR_MEMORY |
Sufficient memory required for processing could not be allocated. |
EPOS2_ERR_FAILURE |
An unknown error occurred. |
Supplementary explanation
- To individually specify the background color in a plurality of windows, define the
window in addSetCurrentTextArea before executing this API.
If the window is defined beforehand, the background color can be specified individually for each window.
By dividing the window at the position where the background color is to be changed, the background color can be changed in the middle of the row. - The background color can be applied only to the text area.
- Specify the r, g, b parameters in the RGB565 format.
- Specify the setting value in all of the r, g, and b parameters.
- To apply the background color to a plurality of rows, execute this API a plurality of times.
Quick Access
- [Name]
- [Format]
- [Range]
- [Description]
- [Notes]
- 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