ClaimedReceiptPrinter
ClaimedReceiptPrinter
ClaimedReceiptPrinter
ClaimedReceiptPrinter
Class
Definition
Represents a receipt printer station that has been claimed for use.
public : sealed class ClaimedReceiptPrinter : IClaimedReceiptPrinter, ICommonClaimedPosPrinterStationpublic sealed class ClaimedReceiptPrinter : IClaimedReceiptPrinter, ICommonClaimedPosPrinterStationPublic NotInheritable Class ClaimedReceiptPrinter Implements IClaimedReceiptPrinter, ICommonClaimedPosPrinterStation// You can use this class in JavaScript.
- Attributes
| 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 get a ClaimedReceiptPrinter object, use the ClaimedPosPrinter.Receipt property.
Properties
CharactersPerLine CharactersPerLine CharactersPerLine CharactersPerLine
Gets or sets the number of characters the receipt printer station can print per line of text.
public : unsigned int CharactersPerLine { get; set; }public uint CharactersPerLine { get; set; }Public ReadWrite Property CharactersPerLine As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The number of characters the receipt printer station can print per line of text.
ColorCartridge ColorCartridge ColorCartridge ColorCartridge
Gets or sets the color cartridge that the receipt printer station should use when it prints.
public : PosPrinterColorCartridge ColorCartridge { get; set; }public PosPrinterColorCartridge ColorCartridge { get; set; }Public ReadWrite Property ColorCartridge As PosPrinterColorCartridge// You can use this property in JavaScript.
- Value
- PosPrinterColorCartridge PosPrinterColorCartridge PosPrinterColorCartridge PosPrinterColorCartridge
An enumeration value that identifies the color cartridge that the receipt printer station should use when it prints.
- See Also
IsCartridgeEmpty IsCartridgeEmpty IsCartridgeEmpty IsCartridgeEmpty
Gets whether the cartridge of the receipt printer station is currently out of ink or toner.
public : PlatForm::Boolean IsCartridgeEmpty { get; }public bool IsCartridgeEmpty { get; }Public ReadOnly Property IsCartridgeEmpty As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the cartridge of the receipt printer station is currently out of ink or toner; otherwise, false.
IsCartridgeRemoved IsCartridgeRemoved IsCartridgeRemoved IsCartridgeRemoved
Gets whether the cartridge of the receipt printer station is currently removed.
public : PlatForm::Boolean IsCartridgeRemoved { get; }public bool IsCartridgeRemoved { get; }Public ReadOnly Property IsCartridgeRemoved As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the cartridge of the receipt printer station is currently removed; otherwise, false.
IsCoverOpen IsCoverOpen IsCoverOpen IsCoverOpen
Gets whether the cover of the receipt printer station is currently open.
public : PlatForm::Boolean IsCoverOpen { get; }public bool IsCoverOpen { get; }Public ReadOnly Property IsCoverOpen As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the cover of the receipt printer station is currently open; otherwise, false.
IsHeadCleaning IsHeadCleaning IsHeadCleaning IsHeadCleaning
Gets whether the receipt printer station is currently cleaning its print head.
public : PlatForm::Boolean IsHeadCleaning { get; }public bool IsHeadCleaning { get; }Public ReadOnly Property IsHeadCleaning As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the receipt printer station is currently cleaning its print head; otherwise, false.
IsLetterQuality IsLetterQuality IsLetterQuality IsLetterQuality
Gets or sets whether the receipt printer station prints with high quality or high speed.
public : PlatForm::Boolean IsLetterQuality { get; set; }public bool IsLetterQuality { get; set; }Public ReadWrite Property IsLetterQuality As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the receipt printer station prints with high quality. False if the receipt printer station prints with high speed.
IsPaperEmpty IsPaperEmpty IsPaperEmpty IsPaperEmpty
Gets whether the receipt printer station needs paper.
public : PlatForm::Boolean IsPaperEmpty { get; }public bool IsPaperEmpty { get; }Public ReadOnly Property IsPaperEmpty As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the receipt printer station needs paper; otherwise, false.
IsPaperNearEnd IsPaperNearEnd IsPaperNearEnd IsPaperNearEnd
Gets whether the receipt printer station is almost out of paper.
public : PlatForm::Boolean IsPaperNearEnd { get; }public bool IsPaperNearEnd { get; }Public ReadOnly Property IsPaperNearEnd As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the receipt printer station is almost out of paper; otherwise, false.
IsReadyToPrint IsReadyToPrint IsReadyToPrint IsReadyToPrint
Gets whether the receipt printer station is on and accepting print jobs.
public : PlatForm::Boolean IsReadyToPrint { get; }public bool IsReadyToPrint { get; }Public ReadOnly Property IsReadyToPrint As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the receipt printer station is on and accepting print jobs; otherwise, false.
LineHeight LineHeight LineHeight LineHeight
Gets or sets the current height of the printed line for the receipt printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.
public : unsigned int LineHeight { get; set; }public uint LineHeight { get; set; }Public ReadWrite Property LineHeight As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The current height of the printed line for the receipt printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.
- See Also
LineSpacing LineSpacing LineSpacing LineSpacing
Gets or sets the spacing of each single-high print line for the receipt printer station, in the units that the ClaimedPosPrinter.MapMode property specifies. This spacing includes both the height of printed line and of the white space between each pair of lines.
public : unsigned int LineSpacing { get; set; }public uint LineSpacing { get; set; }Public ReadWrite Property LineSpacing As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The spacing of each single-high print line for the receipt printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.
LinesToPaperCut LinesToPaperCut LinesToPaperCut LinesToPaperCut
Gets the number of lines that must be advanced before cutting the receipt paper.
public : unsigned int LinesToPaperCut { get; }public uint LinesToPaperCut { get; }Public ReadOnly Property LinesToPaperCut As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The number of lines that must be advanced before cutting the receipt paper.
LineWidth LineWidth LineWidth LineWidth
Gets the current width of the printed line for the receipt printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.
public : unsigned int LineWidth { get; }public uint LineWidth { get; }Public ReadOnly Property LineWidth As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The current width of the printed line for the receipt printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.
- See Also
PageSize PageSize PageSize PageSize
Gets the size of paper that the claimed receipt printer station currently uses.
public : Size PageSize { get; }public Size PageSize { get; }Public ReadOnly Property PageSize As Size// You can use this property in JavaScript.
PrintArea PrintArea PrintArea PrintArea
Gets the print area for the receipt printer station, expressed in the unit of measurement that the ClaimedPosPrinter.MapMode property specifies.
public : Rect PrintArea { get; }public Rect PrintArea { get; }Public ReadOnly Property PrintArea As Rect// You can use this property in JavaScript.
The print area for the receipt printer station, expressed in the unit of measurement that the ClaimedPosPrinter.MapMode property specifies.
SidewaysMaxChars SidewaysMaxChars SidewaysMaxChars SidewaysMaxChars
Gets the maximum number of characters that the receipt printer station can print on each line in sideways mode.
public : unsigned int SidewaysMaxChars { get; }public uint SidewaysMaxChars { get; }Public ReadOnly Property SidewaysMaxChars As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The maximum number of characters that the receipt printer station can print on each line in sideways mode.
- See Also
SidewaysMaxLines SidewaysMaxLines SidewaysMaxLines SidewaysMaxLines
Gets the maximum number of lines that the receipt printer station can print in sideways mode.
public : unsigned int SidewaysMaxLines { get; }public uint SidewaysMaxLines { get; }Public ReadOnly Property SidewaysMaxLines As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The maximum number of lines that the receipt printer station can print in sideways mode.
- See Also
Methods
CreateJob() CreateJob() CreateJob() CreateJob()
Creates a new print job for the receipt printer station.
public : ReceiptPrintJob CreateJob()public ReceiptPrintJob CreateJob()Public Function CreateJob() As ReceiptPrintJob// You can use this method in JavaScript.
The new print job for the receipt printer station.
- See Also
ValidateData(String) ValidateData(String) ValidateData(String) ValidateData(String)
Determines whether a data sequence, possibly including one or more escape sequences, is valid for the receipt printer station, before you use that data sequence when you call the ReceiptPrintJob.Print and ReceiptPrintJob.ExecuteAsync methods.
public : PlatForm::Boolean ValidateData(PlatForm::String data)public bool ValidateData(String data)Public Function ValidateData(data As String) As bool// You can use this method in JavaScript.
- data
- PlatForm::String String String String
The data sequence that you want to validate before you use it with the ReceiptPrintJob.Print method. This sequence may include printable data and escape sequences.
If the sequence is not valid, and you use it with ReceiptPrintJob.Print anyways, the job fails when you run it with ReceiptPrintJob.ExecuteAsync. You cannot remove a print instruction that uses an invalid data sequence after you add the instruction to the job with ReceiptPrintJob.Print.
True if the data passes validation; otherwise false.