ReceiptPrintJob ReceiptPrintJob ReceiptPrintJob ReceiptPrintJob Class

Definition

Represents a set of printing instructions that you want to run on the receipt printer.

public : sealed class ReceiptPrintJob : IPosPrinterJob, IReceiptOrSlipJob, IReceiptPrintJobpublic sealed class ReceiptPrintJob : IPosPrinterJob, IReceiptOrSlipJob, IReceiptPrintJobPublic NotInheritable Class ReceiptPrintJob Implements IPosPrinterJob, IReceiptOrSlipJob, IReceiptPrintJob// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

To create a new print job for the receipt printer, call ClaimedReceiptPrinter.CreateJob. The created print job object is valid as long as the ClaimedReceiptPrinter object that created it is valid.

Methods

CutPaper() CutPaper() CutPaper() CutPaper()

Adds an instruction to the printer job to cut the receipt paper completely.

public : void CutPaper()public void CutPaper()Public Function CutPaper() As void// You can use this method in JavaScript.
See Also

CutPaper(Double) CutPaper(Double) CutPaper(Double) CutPaper(Double)

Adds an instruction to the printer job to cut the specified percentage of the receipt paper.

public : void CutPaper(double percentage)public void CutPaper(Double percentage)Public Function CutPaper(percentage As Double) As void// You can use this method in JavaScript.
Parameters
percentage
double Double Double Double

Decimal representation of the percentage of the receipt that the receipt printer should cut.

Many printers with paper cutting capability can perform both full and partial cuts. Some offer gradations of partial cuts, such as a perforated cut and an almost-full cut. Use the following general guidelines:

ValueMeaning
1.0Fully cuts the paper.
0.9Leaves only a small part of paper for very easy final separation.
0.7Perforates the paper for final separation that is somewhat more difficult and unlikely to occur by accidental handling.
0.5Partial perforation of the paper.

Printer capabilities vary, so the actual result can be device-dependent.

See Also

DrawRuledLine(String, PosPrinterLineDirection, UInt32, PosPrinterLineStyle, UInt32) DrawRuledLine(String, PosPrinterLineDirection, UInt32, PosPrinterLineStyle, UInt32) DrawRuledLine(String, PosPrinterLineDirection, UInt32, PosPrinterLineStyle, UInt32) DrawRuledLine(String, PosPrinterLineDirection, UInt32, PosPrinterLineStyle, UInt32)

Adds an instruction to the print job to print a drawn, ruled line on the paper of the receipt printer station.

public : void DrawRuledLine(PlatForm::String positionList, PosPrinterLineDirection lineDirection, unsigned int lineWidth, PosPrinterLineStyle lineStyle, unsigned int lineColor)public void DrawRuledLine(String positionList, PosPrinterLineDirection lineDirection, UInt32 lineWidth, PosPrinterLineStyle lineStyle, UInt32 lineColor)Public Function DrawRuledLine(positionList As String, lineDirection As PosPrinterLineDirection, lineWidth As UInt32, lineStyle As PosPrinterLineStyle, lineColor As UInt32) As void// You can use this method in JavaScript.
Parameters
positionList
PlatForm::String String String String

The position parameters for the ruled line. The character string for positionList differs depending on whether lineDirection specifies a horizontal ruled line or a vertical ruled line (see remarks).

lineDirection
PosPrinterLineDirection PosPrinterLineDirection PosPrinterLineDirection PosPrinterLineDirection

The direction in which to print the ruled line.

lineWidth
unsigned int UInt32 UInt32 UInt32

The width of the ruled line that the print should print. The unit of width is dot. If an unsupported value is specified, the best fit value for the printer is used.

lineStyle
PosPrinterLineStyle PosPrinterLineStyle PosPrinterLineStyle PosPrinterLineStyle

The appearance of the ruled line, such as whether it is solid or broken, or single or double.

lineColor
unsigned int UInt32 UInt32 UInt32

The color of the ruled line, as an integer value that is equal to the value of the cartridge constant used in the ClaimedReceiptPrinter.ColorCartridge property. If an unsupported value is specified, the printing results may be unpredictable.

Remarks

The positionList argument varies depending on whether a horizontal or vertical ruled line is being drawn.

For horizontal ruled lines, positionList consists of comma delimited numbers (units of measure are defined by the MapMode property), which denote the starting position and length of each line. Each pair is followed by a semicolon if multiple ruled lines are specified. The pattern is repeated for all additional horizontal ruled lines. Consider this example:

positionList = "0,500"

This positionList would result in a ruled line starting at MapMode unit position "0" continuing for 500 MapMode units of length. Here is another example demonstrating multiple horizontal lines:

positionList = "0,200;300,100"

This positionList would result in a ruled line starting at unit position "0" and continuing for 200 units in length. Then, another line would begin at position 300 and continue for 100 units in length.

For vertical ruled lines, positionList consists of comma delimited numbers (units of measure are defined by the MapMode property) which denote the positions for the vertical drawn rules line(s). A continue vertical ruled line will be drawn from each position for the print lines that follow, until the vertical rules lines are changed or terminated by a call to DrawRuledLine or a ruled line escape sequence. An empty string in the positionLine argument causes the vertical ruled lines to be terminated. Consider this example:

positionList = "0,100,400,500"

This positionList results in four drawn ruled lines starting at unit positions "0", "100", "400", and "500" when each line of data is printed.

See Also

ExecuteAsync() ExecuteAsync() ExecuteAsync() ExecuteAsync()

Runs the print job on the receipt printer station asynchronously.

public : IAsyncOperation<PlatForm::Boolean> ExecuteAsync()public IAsyncOperation<bool> ExecuteAsync()Public Function ExecuteAsync() As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Returns

The operation to run the print job. This operation returns true if the print job succeeds; otherwise, the operation returns false.

Remarks

The print job is sent to the claimed printer station object that created the print job. The claimed printer station object must remain valid when calling this method.

MarkFeed(PosPrinterMarkFeedKind) MarkFeed(PosPrinterMarkFeedKind) MarkFeed(PosPrinterMarkFeedKind) MarkFeed(PosPrinterMarkFeedKind)

Adds an instruction to the printer job to use the mark sensor of the receipt printer station to position the receipt paper.

public : void MarkFeed(PosPrinterMarkFeedKind kind)public void MarkFeed(PosPrinterMarkFeedKind kind)Public Function MarkFeed(kind As PosPrinterMarkFeedKind) As void// You can use this method in JavaScript.
Parameters
kind
PosPrinterMarkFeedKind PosPrinterMarkFeedKind PosPrinterMarkFeedKind PosPrinterMarkFeedKind

An enumeration value that specifies how to position the receipt paper.

See Also

Print(String) Print(String) Print(String) Print(String)

Adds an instruction to the print job to print the specified text on the receipt printer station.

public : void Print(PlatForm::String data)public void Print(String data)Public Function Print(data As String) As void// You can use this method in JavaScript.
Parameters
data
PlatForm::String String String String

The text to print on the receipt printer station.

Remarks

If ClaimedPosPrinter.IsCharacterSetMappingEnabled is true, the text is mapped to the font on the printer that ClaimedPosPrinter.CharacterSet specifies. If ClaimedPosPrinter.IsCharacterSetMappingEnabled is false, the driver or provider sends the low byte of each Unicode character to the printer verbatim.

PrintBarcode(String, UInt32, UInt32, UInt32, PosPrinterBarcodeTextPosition, PosPrinterAlignment) PrintBarcode(String, UInt32, UInt32, UInt32, PosPrinterBarcodeTextPosition, PosPrinterAlignment) PrintBarcode(String, UInt32, UInt32, UInt32, PosPrinterBarcodeTextPosition, PosPrinterAlignment) PrintBarcode(String, UInt32, UInt32, UInt32, PosPrinterBarcodeTextPosition, PosPrinterAlignment)

Adds an instruction to the print job to print a barcode with the specified data and symbology on the receipt printer station.

public : void PrintBarcode(PlatForm::String data, unsigned int symbology, unsigned int height, unsigned int width, PosPrinterBarcodeTextPosition textPosition, PosPrinterAlignment alignment)public void PrintBarcode(String data, UInt32 symbology, UInt32 height, UInt32 width, PosPrinterBarcodeTextPosition textPosition, PosPrinterAlignment alignment)Public Function PrintBarcode(data As String, symbology As UInt32, height As UInt32, width As UInt32, textPosition As PosPrinterBarcodeTextPosition, alignment As PosPrinterAlignment) As void// You can use this method in JavaScript.
Parameters
data
PlatForm::String String String String

The data to be represented as a barcode.

symbology
unsigned int UInt32 UInt32 UInt32

The symbology (encoding) of the barcode. This can be determined based on the BarcodeSymbologies class static methods.

height
unsigned int UInt32 UInt32 UInt32

The height of the barcode, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

width
unsigned int UInt32 UInt32 UInt32

The width of the barcode.

This value is interpreted in one of two ways:

The width of the entire barcode, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

or, (though we discourage using this method) if the value is less than or equal to 6, it is interprested as described below:

ESC/POS control language is used for most Windows POS device communication, and ESC/POS only accepts integers from 2 to 6. Each value contains a matched measurement for the thin and thick elements of a barcode. In order for a barcode to be read properly, the width of the lines is crucial, especially when scaling. Additionally, the minimum width capability varies by printer model.

Actual sizes are dependent on the capabilities of the target printer, but approximate sizes for accepted values are:

Width ValueThin ElementThick Element
20.250 - 0.282 mm0.625 - 0.706 mm
30.375 - 0.423 mm1.000 - 1.129 mm
40.500 - 0.564 mm1.250 - 1.411 mm
50.625 - 0.706 mm1.625 - 1.834 mm
60.750 - 0.847 mm2.000 - 2.258 mm

See the remarks in POS Printer for more information on ESC/POS.

textPosition
PosPrinterBarcodeTextPosition PosPrinterBarcodeTextPosition PosPrinterBarcodeTextPosition PosPrinterBarcodeTextPosition

The vertical position of the barcode text relative to the barcode.

alignment
PosPrinterAlignment PosPrinterAlignment PosPrinterAlignment PosPrinterAlignment

The horizontal alignment of the barcode on the page.

PrintBarcodeCustomAlign(String, UInt32, UInt32, UInt32, PosPrinterBarcodeTextPosition, UInt32) PrintBarcodeCustomAlign(String, UInt32, UInt32, UInt32, PosPrinterBarcodeTextPosition, UInt32) PrintBarcodeCustomAlign(String, UInt32, UInt32, UInt32, PosPrinterBarcodeTextPosition, UInt32) PrintBarcodeCustomAlign(String, UInt32, UInt32, UInt32, PosPrinterBarcodeTextPosition, UInt32)

Adds an instruction to the print job to print a barcode with the specified data, symbology, and custom alignment on the receipt printer station.

public : void PrintBarcodeCustomAlign(PlatForm::String data, unsigned int symbology, unsigned int height, unsigned int width, PosPrinterBarcodeTextPosition textPosition, unsigned int alignmentDistance)public void PrintBarcodeCustomAlign(String data, UInt32 symbology, UInt32 height, UInt32 width, PosPrinterBarcodeTextPosition textPosition, UInt32 alignmentDistance)Public Function PrintBarcodeCustomAlign(data As String, symbology As UInt32, height As UInt32, width As UInt32, textPosition As PosPrinterBarcodeTextPosition, alignmentDistance As UInt32) As void// You can use this method in JavaScript.
Parameters
data
PlatForm::String String String String

The data to be represented as a barcode.

symbology
unsigned int UInt32 UInt32 UInt32

The symbology (encoding) of the barcode.

height
unsigned int UInt32 UInt32 UInt32

The height of the barcode, in pixels.

width
unsigned int UInt32 UInt32 UInt32

The width of the barcode, in pixels.

textPosition
PosPrinterBarcodeTextPosition PosPrinterBarcodeTextPosition PosPrinterBarcodeTextPosition PosPrinterBarcodeTextPosition

The vertical position of the barcode text relative to the barcode.

alignmentDistance
unsigned int UInt32 UInt32 UInt32

The distance from the leftmost print column to the start of the barcode, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

PrintBitmap(BitmapFrame, PosPrinterAlignment) PrintBitmap(BitmapFrame, PosPrinterAlignment) PrintBitmap(BitmapFrame, PosPrinterAlignment) PrintBitmap(BitmapFrame, PosPrinterAlignment)

Adds an instruction to the print job to print the specified bitmap with the specified standard horizontal placement on the receipt printer station.

public : void PrintBitmap(BitmapFrame bitmap, PosPrinterAlignment alignment)public void PrintBitmap(BitmapFrame bitmap, PosPrinterAlignment alignment)Public Function PrintBitmap(bitmap As BitmapFrame, alignment As PosPrinterAlignment) As void// You can use this method in JavaScript.
Parameters
bitmap
BitmapFrame BitmapFrame BitmapFrame BitmapFrame

Information about the bitmap that you want to print.

alignment
PosPrinterAlignment PosPrinterAlignment PosPrinterAlignment PosPrinterAlignment

An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned.

See Also

PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32) PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32) PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32) PrintBitmap(BitmapFrame, PosPrinterAlignment, UInt32)

Adds an instruction to the print job to print the specified bitmap with the specified width and a standard horizontal placement on the receipt printer station.

public : void PrintBitmap(BitmapFrame bitmap, PosPrinterAlignment alignment, unsigned int width)public void PrintBitmap(BitmapFrame bitmap, PosPrinterAlignment alignment, UInt32 width)Public Function PrintBitmap(bitmap As BitmapFrame, alignment As PosPrinterAlignment, width As UInt32) As void// You can use this method in JavaScript.
Parameters
bitmap
BitmapFrame BitmapFrame BitmapFrame BitmapFrame

Information about the bitmap that you want to print.

alignment
PosPrinterAlignment PosPrinterAlignment PosPrinterAlignment PosPrinterAlignment

An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned.

width
unsigned int UInt32 UInt32 UInt32

The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

See Also

PrintCustomAlignedBitmap(BitmapFrame, UInt32) PrintCustomAlignedBitmap(BitmapFrame, UInt32) PrintCustomAlignedBitmap(BitmapFrame, UInt32) PrintCustomAlignedBitmap(BitmapFrame, UInt32)

Adds an instruction to the print job to print the specified bitmap at the specified distance from the leftmost print column on the receipt printer station.

public : void PrintCustomAlignedBitmap(BitmapFrame bitmap, unsigned int alignmentDistance)public void PrintCustomAlignedBitmap(BitmapFrame bitmap, UInt32 alignmentDistance)Public Function PrintCustomAlignedBitmap(bitmap As BitmapFrame, alignmentDistance As UInt32) As void// You can use this method in JavaScript.
Parameters
bitmap
BitmapFrame BitmapFrame BitmapFrame BitmapFrame

Information about the bitmap that you want to print.

alignmentDistance
unsigned int UInt32 UInt32 UInt32

The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

See Also

PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32) PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32) PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32) PrintCustomAlignedBitmap(BitmapFrame, UInt32, UInt32)

Adds an instruction to the print job to print the specified bitmap with the specified width and at the specified distance from the leftmost print column on the receipt printer station.

public : void PrintCustomAlignedBitmap(BitmapFrame bitmap, unsigned int alignmentDistance, unsigned int width)public void PrintCustomAlignedBitmap(BitmapFrame bitmap, UInt32 alignmentDistance, UInt32 width)Public Function PrintCustomAlignedBitmap(bitmap As BitmapFrame, alignmentDistance As UInt32, width As UInt32) As void// You can use this method in JavaScript.
Parameters
bitmap
BitmapFrame BitmapFrame BitmapFrame BitmapFrame

Information about the bitmap that you want to print.

alignmentDistance
unsigned int UInt32 UInt32 UInt32

The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

width
unsigned int UInt32 UInt32 UInt32

The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPriinter.MapMode property.

See Also

PrintLine() PrintLine() PrintLine() PrintLine()

Adds an instruction to the print job to print a newline character on the receipt printer station.

public : void PrintLine()public void PrintLine()Public Function PrintLine() As void// You can use this method in JavaScript.
See Also

PrintLine(String) PrintLine(String) PrintLine(String) PrintLine(String)

Adds an instruction to the print job to print a line of text on the receipt printer station.

public : void PrintLine(PlatForm::String data)public void PrintLine(String data)Public Function PrintLine(data As String) As void// You can use this method in JavaScript.
Parameters
data
PlatForm::String String String String

The line of text to print.

See Also

PrintSavedBitmap(UInt32) PrintSavedBitmap(UInt32) PrintSavedBitmap(UInt32) PrintSavedBitmap(UInt32)

Adds an instruction to the print job to print a bitmap on the receipt printer station by using the bitmap and information saved to the printer via SetBitmap or SetCustomAlignedBitmap.

public : void PrintSavedBitmap(unsigned int bitmapNumber)public void PrintSavedBitmap(UInt32 bitmapNumber)Public Function PrintSavedBitmap(bitmapNumber As UInt32) As void// You can use this method in JavaScript.
Parameters
bitmapNumber
unsigned int UInt32 UInt32 UInt32

The number that you assigned to the bitmap that you want to print when you called SetBitmap or SetCustomAlignedBitmap.

Remarks

The bitmap rotation setting that you specify by calling ReceiptPrintJob.SetPrintRotation may not apply to bitmaps that you saved to the printer.

See Also

SetBarcodeRotation(PosPrinterRotation) SetBarcodeRotation(PosPrinterRotation) SetBarcodeRotation(PosPrinterRotation) SetBarcodeRotation(PosPrinterRotation)

Sets the rotation of the barcode on the page on the receipt printer station.

public : void SetBarcodeRotation(PosPrinterRotation value)public void SetBarcodeRotation(PosPrinterRotation value)Public Function SetBarcodeRotation(value As PosPrinterRotation) As void// You can use this method in JavaScript.
Parameters
value
PosPrinterRotation PosPrinterRotation PosPrinterRotation PosPrinterRotation

The rotation of the barcode on the page.

SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment) SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment) SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment) SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment)

Saves information about a bitmap and a standard horizontal placement that you want to use to print that bitmap on the receipt printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

public : void SetBitmap(unsigned int bitmapNumber, BitmapFrame bitmap, PosPrinterAlignment alignment)public void SetBitmap(UInt32 bitmapNumber, BitmapFrame bitmap, PosPrinterAlignment alignment)Public Function SetBitmap(bitmapNumber As UInt32, bitmap As BitmapFrame, alignment As PosPrinterAlignment) As void// You can use this method in JavaScript.
Parameters
bitmapNumber
unsigned int UInt32 UInt32 UInt32

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job.

bitmap
BitmapFrame BitmapFrame BitmapFrame BitmapFrame

Information about the bitmap that you want to print.

alignment
PosPrinterAlignment PosPrinterAlignment PosPrinterAlignment PosPrinterAlignment

An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned.

Remarks

If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer.

See Also

SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32) SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32) SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32) SetBitmap(UInt32, BitmapFrame, PosPrinterAlignment, UInt32)

Saves information about a bitmap, along with the width and a standard horizontal placement that you want to use to print that bitmap on the receipt printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

public : void SetBitmap(unsigned int bitmapNumber, BitmapFrame bitmap, PosPrinterAlignment alignment, unsigned int width)public void SetBitmap(UInt32 bitmapNumber, BitmapFrame bitmap, PosPrinterAlignment alignment, UInt32 width)Public Function SetBitmap(bitmapNumber As UInt32, bitmap As BitmapFrame, alignment As PosPrinterAlignment, width As UInt32) As void// You can use this method in JavaScript.
Parameters
bitmapNumber
unsigned int UInt32 UInt32 UInt32

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job.

bitmap
BitmapFrame BitmapFrame BitmapFrame BitmapFrame

Information about the bitmap that you want to print.

alignment
PosPrinterAlignment PosPrinterAlignment PosPrinterAlignment PosPrinterAlignment

An enumeration value that specifies a standard horizontal placement on the page for the bitmap, such as left-aligned, centered, or right-aligned.

width
unsigned int UInt32 UInt32 UInt32

The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

Remarks

If the printer for the print job has non-volatile bitmap storage, this method saves the bitmap to the printer hardware, which can cause wear and damage to the flash storage for the printer.

See Also

SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32) SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32) SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32) SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32)

Saves information about a bitmap and the distance from the leftmost print column at which you want to print that bitmap on the receipt printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

public : void SetCustomAlignedBitmap(unsigned int bitmapNumber, BitmapFrame bitmap, unsigned int alignmentDistance)public void SetCustomAlignedBitmap(UInt32 bitmapNumber, BitmapFrame bitmap, UInt32 alignmentDistance)Public Function SetCustomAlignedBitmap(bitmapNumber As UInt32, bitmap As BitmapFrame, alignmentDistance As UInt32) As void// You can use this method in JavaScript.
Parameters
bitmapNumber
unsigned int UInt32 UInt32 UInt32

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job.

bitmap
BitmapFrame BitmapFrame BitmapFrame BitmapFrame

Information about the bitmap that you want to print.

alignmentDistance
unsigned int UInt32 UInt32 UInt32

The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

See Also

SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32) SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32) SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32) SetCustomAlignedBitmap(UInt32, BitmapFrame, UInt32, UInt32)

Saves information about a bitmap, along with the width and the distance from the leftmost print column that you want to use to print that bitmap on the receipt printer station, so that you can use the PrintSavedBitmap method to add that information to the print job later.

public : void SetCustomAlignedBitmap(unsigned int bitmapNumber, BitmapFrame bitmap, unsigned int alignmentDistance, unsigned int width)public void SetCustomAlignedBitmap(UInt32 bitmapNumber, BitmapFrame bitmap, UInt32 alignmentDistance, UInt32 width)Public Function SetCustomAlignedBitmap(bitmapNumber As UInt32, bitmap As BitmapFrame, alignmentDistance As UInt32, width As UInt32) As void// You can use this method in JavaScript.
Parameters
bitmapNumber
unsigned int UInt32 UInt32 UInt32

The number that you want to assign to this bitmap. You can set two bitmaps, numbered 1 and 2. Use this number with the PrintSavedBitmap method later to add the print instructions to the print job.

bitmap
BitmapFrame BitmapFrame BitmapFrame BitmapFrame

Information about the bitmap that you want to print.

alignmentDistance
unsigned int UInt32 UInt32 UInt32

The distance from the leftmost print column to the start of the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

width
unsigned int UInt32 UInt32 UInt32

The width to use for printing the bitmap, expressed in the unit of measurement indicated by the ClaimedPosPrinter.MapMode property.

See Also

SetPrintArea(Rect) SetPrintArea(Rect) SetPrintArea(Rect) SetPrintArea(Rect)

Sets the area of the page on which the receipt printer station can print the job.

public : void SetPrintArea(Rect value)public void SetPrintArea(Rect value)Public Function SetPrintArea(value As Rect) As void// You can use this method in JavaScript.
Parameters
value
Rect Rect Rect Rect

The area of the page on which the receipt printer can print the job.

Remarks

When you call this method for a print job, all instructions in the print job run within the specified print area, including the instructions that you added to the job before you called ReceiptPrintJob.SetPrintArea.

SetPrintRotation(PosPrinterRotation, Boolean) SetPrintRotation(PosPrinterRotation, Boolean) SetPrintRotation(PosPrinterRotation, Boolean) SetPrintRotation(PosPrinterRotation, Boolean)

Sets the rotation of the text or image on the page for the receipt printer station.

public : void SetPrintRotation(PosPrinterRotation value, bool includeBitmaps)public void SetPrintRotation(PosPrinterRotation value, Boolean includeBitmaps)Public Function SetPrintRotation(value As PosPrinterRotation, includeBitmaps As Boolean) As void// You can use this method in JavaScript.
Parameters
value
PosPrinterRotation PosPrinterRotation PosPrinterRotation PosPrinterRotation

The rotation of the text or image on the page for the receipt printer station.

includeBitmaps
bool Boolean Boolean Boolean

Whether bitmaps should also be rotated. This setting takes effect only for subsequent calls to PrintBitmap, and may not apply to saved bitmaps that you print using PrintSavedBitmap.

Remarks

This rotation setting persists beyond the current print job.