ClaimedJournalPrinter Class

  • Reference

Definition

Namespace:
Windows.Devices.PointOfService
Edit

Represents a journal printer station that has been claimed for use.

public ref class ClaimedJournalPrinter sealed
public ref class ClaimedJournalPrinter sealed : ICommonClaimedPosPrinterStation
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ClaimedJournalPrinter final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ClaimedJournalPrinter final : ICommonClaimedPosPrinterStation
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ClaimedJournalPrinter
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ClaimedJournalPrinter : ICommonClaimedPosPrinterStation
Public NotInheritable Class ClaimedJournalPrinter
Public NotInheritable Class ClaimedJournalPrinter
Implements ICommonClaimedPosPrinterStation
Inheritance
Object Platform::Object IInspectable ClaimedJournalPrinter
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute
Implements
ICommonClaimedPosPrinterStation

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

To get a ClaimedJournalPrinter object, use the ClaimedPosPrinter.Journal property.

Properties

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.
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.
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.
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.
IsCoverOpen

Gets whether the printer cover for the journal printer station is open.
IsHeadCleaning

Gets whether the head for the journal printer station is currently cleaning.
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.
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.
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.
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.
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.
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.
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.

Methods

CreateJob()

Creates a new print job for the journal printer station.
ValidateData(String)

Determines if a JournalPrintJob can successfully execute a print instruction with the specified data.

Applies to

See also