ClaimedJournalPrinter
ClaimedJournalPrinter
ClaimedJournalPrinter
ClaimedJournalPrinter
Class
Definition
Represents a journal printer station that has been claimed for use.
public : sealed class ClaimedJournalPrinter : IClaimedJournalPrinter, ICommonClaimedPosPrinterStationpublic sealed class ClaimedJournalPrinter : IClaimedJournalPrinter, ICommonClaimedPosPrinterStationPublic NotInheritable Class ClaimedJournalPrinter Implements IClaimedJournalPrinter, 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 ClaimedJournalPrinter object, use the ClaimedPosPrinter.Journal property.
Properties
CharactersPerLine CharactersPerLine CharactersPerLine CharactersPerLine
Gets or sets the number of characters per line for the journal printer station.
It is worth noting that changing this property can potentially change the LineHeight, LineSpacing and LineWidth properties.
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.
ColorCartridge ColorCartridge ColorCartridge ColorCartridge
Gets or sets the color cartridge that the journal printer station should use when it prints. This property must agree with what is available through ColorCartridgeCapabilities.
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 journal printer station should use when it prints.
- See Also
IsCartridgeEmpty IsCartridgeEmpty IsCartridgeEmpty IsCartridgeEmpty
Gets whether the printer cartridge for the journal printer station is empty. Note, this may throw an exception if the corresponding sensor is not available on the printer. See JournalPrinterCapabilities to verify sensor availability.
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 printer cartridge is empty; otherwise false.
IsCartridgeRemoved IsCartridgeRemoved IsCartridgeRemoved IsCartridgeRemoved
Gets whether the cartridge for journal printer station has been removed. Note, this may throw an exception if the corresponding sensor is not available on the printer. See JournalPrinterCapabilities to verify sensor availability.
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 is missing; otherwise false.
IsCoverOpen IsCoverOpen IsCoverOpen IsCoverOpen
Gets whether the printer cover for the journal printer station is 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 is open; otherwise false.
IsHeadCleaning IsHeadCleaning IsHeadCleaning IsHeadCleaning
Gets whether the head for the journal printer station is currently cleaning.
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 head is currently cleaning; otherwise false.
IsLetterQuality IsLetterQuality IsLetterQuality IsLetterQuality
Gets or sets whether the journal printer station prints with high quality or high speed. Note, this may throw an exception if the corresponding sensor is not available on the printer.
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 journal printer station prints with high quality. False if the journal printer station prints with high speed.
IsPaperEmpty IsPaperEmpty IsPaperEmpty IsPaperEmpty
Gets whether the paper is empty for the journal printer station. Note, this may throw an exception if the corresponding sensor is not available on the printer. See JournalPrinterCapabilities to verify sensor availability.
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 printer is out of paper; otherwise false.
IsPaperNearEnd IsPaperNearEnd IsPaperNearEnd IsPaperNearEnd
Gets whether the printer paper is near the end for the journal printer station. Note, this may throw an exception if the corresponding sensor is not available on the printer. See JournalPrinterCapabilities to verify sensor availability.
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 paper is near the end; otherwise false.
IsReadyToPrint IsReadyToPrint IsReadyToPrint IsReadyToPrint
Gets whether the journal printer station is ready to print. Note, this may throw an exception if the corresponding sensor is not available on the printer. See JournalPrinterCapabilities to verify sensor availability.
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 printer is ready to print; otherwise false.
LineHeight LineHeight LineHeight LineHeight
Gets or sets the current height of the printed line for the journal printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.
It is worth noting that changing this property can potentially change the CharactersPerLine, LineSpacing and LineWidth properties.
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 journal 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 journal 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.
It is worth noting that changing this property can potentially change the CharactersPerLine, LineHeight and LineWidth properties.
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 journal printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.
LineWidth LineWidth LineWidth LineWidth
Gets the current width of the printed line for the journal printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.
It is worth noting that changing this property can potentially change the CharactersPerLine, LineHeight and LineSpacing properties.
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 journal printer station, in the units that the ClaimedPosPrinter.MapMode property specifies.
- See Also
Methods
CreateJob() CreateJob() CreateJob() CreateJob()
Creates a new print job for the journal printer station.
public : JournalPrintJob CreateJob()public JournalPrintJob CreateJob()Public Function CreateJob() As JournalPrintJob// You can use this method in JavaScript.
The new print job for the journal printer station.
- See Also
ValidateData(String) ValidateData(String) ValidateData(String) ValidateData(String)
Determines if a JournalPrintJob can successfully execute a print instruction with the specified data.
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 JournalPrintJob.Print method. This sequence may include printable data and escape sequences.
If the sequence is not valid, and you use it with JournalPrintJob.Print anyways, the job fails when you run it with JournalPrintJob.ExecuteAsync. You cannot remove a print instruction that uses an invalid data sequence after you add the instruction to the job with JournalPrintJob.Print.
True if the data passes validation; otherwise false.